Interface paths

This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

interface paths {
 "/access-tokens/latest/projects/{projectKey}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 createdDate?: string;
 id?: string;
 name?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/access-tokens/latest/projects/{projectKey}/{tokenId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 createdDate?: string;
 id?: string;
 name?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}/{tokenId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/access-tokens/latest/users/{userSlug}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 createdDate?: string;
 id?: string;
 name?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/access-tokens/latest/users/{userSlug}/{tokenId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/admin": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 keyTypeRestrictions?: readonly {
 algorithm?: string;
 allowed?: boolean;
 minKeyLength?: { asInt?: ...; present?: ... };
 }[];
 maxExpiryDays?: { asInt?: number; present?: boolean };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 keyTypeRestrictions?: readonly {
 algorithm?: string;
 allowed?: boolean;
 minKeyLength?: { asInt?: ...; present?: ... };
 }[];
 maxExpiryDays?: { asInt?: number; present?: boolean };
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/admin/supported-key-types": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/banner": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 audience?: "ALL"
 | "AUTHENTICATED";
 enabled?: boolean;
 message?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 audience: "ALL"
 | "AUTHENTICATED";
 enabled?: boolean;
 message?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/cluster": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 localNode?: {
 address?: { address?: (...)
 | (...); port?: (...) | (...) };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 };
 nodes?: readonly {
 address?: { address?: ...; port?: ... };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 }[];
 running?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/default-branch": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": { id?: string } } };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/git/mesh/config/control-plane.pem": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "text/plain": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/git/mesh/diagnostics/connectivity": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 reports?: readonly {
 node?: { id?: ...; name?: ...; type?: ... };
 summaries?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/git/mesh/nodes": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: | "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: | "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/git/mesh/nodes/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: number };
 query?: { force?: boolean };
 };
 requestBody?: undefined;
 responses: {
 default: {
 content: { "application/json;charset=UTF-8": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: | "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: | "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/git/mesh/support-zips": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/octet-stream": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/git/mesh/support-zips/{id}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/octet-stream": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/groups": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": { deletable?: boolean; name?: string };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": { deletable?: boolean; name?: string };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/groups/add-user": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { context?: string; itemName?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/groups/add-users": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { group?: string; users: readonly string[] };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/groups/more-members": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 context: string;
 filter?: string;
 limit?: number;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/groups/more-non-members": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 context: string;
 filter?: string;
 limit?: number;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/groups/remove-user": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { context?: string; itemName?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/license": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/mail-server": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP"
 | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP"
 | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP"
 | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/mail-server/sender-address": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": string } };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/permissions/groups": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 name: readonly string[];
 permission: "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_CREATE"
 | "SYS_ADMIN";
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/permissions/groups/none": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/permissions/users": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 name: readonly string[];
 permission: "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_CREATE"
 | "SYS_ADMIN";
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/permissions/users/none": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/pull-requests/{scmId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scmId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 commitMessageTemplate?: { body?: string; title?: string };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<string, unknown>;
 name?: string;
 };
 strategies?: readonly {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<(...), (...)>;
 name?: string;
 }[];
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scmId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 mergeConfig?: {
 commitMessageTemplate?: {
 body?: (...)
 | (...);
 title?: (...) | (...);
 };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: (...)
 | (...);
 enabled?: (...) | (...) | (...);
 flag?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 };
 strategies?: readonly {
 description?: ...;
 enabled?: ...;
 flag?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 }[];
 type?: string;
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 commitMessageTemplate?: { body?: string; title?: string };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<string, unknown>;
 name?: string;
 };
 strategies?: readonly {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<(...), (...)>;
 name?: string;
 }[];
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/rate-limit/history": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 limit?: number;
 order?: "FREQUENCY"
 | "NEWEST";
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 lastRejectTime?: number;
 rejectCount?: number;
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/rate-limit/settings": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/rate-limit/settings/users": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 settings?: { capacity?: ...; fillRate?: ... };
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 whitelisted?: boolean;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 usernames?: readonly string[];
 whitelisted?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/rate-limit/settings/users/{userSlug}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 whitelisted?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/user-directories": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { includeInactive?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 description?: string;
 name?: string;
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/users": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<string, unknown>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 addToDefaultGroup?: boolean;
 displayName: string;
 emailAddress: string;
 name: string;
 notify?: boolean;
 password?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 displayName?: string;
 email?: string;
 name?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<string, unknown>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/users/add-group": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { context?: string; itemName?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/users/add-groups": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { groups: readonly string[]; user?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/users/captcha": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/users/credentials": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 name?: string;
 password?: string;
 passwordConfirm?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/admin/users/erasure": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": { newIdentifier?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/users/more-members": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 context: string;
 filter?: string;
 limit?: number;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/users/more-non-members": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 context: string;
 filter?: string;
 limit?: number;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/users/remove-group": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { context?: string; itemName?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/admin/users/rename": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: { "application/json": { name?: string; newName?: string } };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<string, unknown>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/application-properties": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 buildDate?: string;
 buildNumber?: string;
 displayName?: string;
 version?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/build/capabilities": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": { buildStatus?: readonly string[] } };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/dashboard/pull-request-suggestions": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { changesSince?: string; limit?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 changeTme?: number;
 fromRef?: { displayId?: ...; id?: ...; type?: ... };
 refChange?: {
 fromHash?: ...;
 ref?: ...;
 refId?: ...;
 toHash?: ...;
 type?: ...;
 };
 repository?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 origin?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 toRef?: { displayId?: ...; id?: ...; type?: ... };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/dashboard/pull-requests": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 closedSince?: string;
 limit?: number;
 order?: string;
 participantStatus?: string;
 role?: string;
 start?: number;
 state?: string;
 user?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: ...;
 id?: ...;
 latestCommit?: ...;
 repository?: ...;
 type?: ...;
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<(...), (...)>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly (...)[];
 reviewers?: readonly (...)[];
 state?: "DECLINED" | "MERGED" | "OPEN";
 title?: string;
 toRef?: {
 displayId?: ...;
 id?: ...;
 latestCommit?: ...;
 repository?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/deployment/capabilities": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/groups": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly string[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/hook-scripts": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "multipart/form-data": {
 content?: string;
 description?: string;
 name?: string;
 type?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 description?: string;
 id?: number;
 name?: string;
 pluginKey?: string;
 type?: "POST"
 | "PRE";
 updatedDate?: string;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/hook-scripts/{scriptId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scriptId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scriptId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 description?: string;
 id?: number;
 name?: string;
 pluginKey?: string;
 type?: "POST"
 | "PRE";
 updatedDate?: string;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scriptId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "*/*": { content?: string; description?: string; name?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 description?: string;
 id?: number;
 name?: string;
 pluginKey?: string;
 type?: "POST"
 | "PRE";
 updatedDate?: string;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "422": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/hook-scripts/{scriptId}/content": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scriptId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/hooks/{hookKey}/avatar": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { hookKey: string };
 query?: { version?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/inbox/pull-requests": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { limit?: number; role?: string; start?: number };
 };
 requestBody?: undefined;
 responses: {
 default: {
 content: { "application/json;charset=UTF-8": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/inbox/pull-requests/count": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 default: {
 content: { "application/json;charset=UTF-8": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/labels": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { limit?: number; prefix?: string; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/labels/{labelName}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { labelName: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": { name?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/labels/{labelName}/labeled": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { labelName: string };
 query?: { limit?: number; start?: number; type?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 labelableType?: "REPOSITORY";
 links?: Record<(...), (...)>;
 name?: string;
 origin?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 partition?: number;
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 public?: boolean;
 relatedLinks?: Record<(...), (...)>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/logs/logger/{loggerName}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { loggerName: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": { logLevel?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/logs/logger/{loggerName}/{levelName}": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { levelName: string; loggerName: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/logs/rootLogger": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": { logLevel?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/logs/rootLogger/{levelName}": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { levelName: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/markup/preview": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 hardwrap?: string;
 htmlEscape?: string;
 includeHeadingId?: string;
 urlMode?: string;
 };
 };
 requestBody?: { content: { "*/*": string } };
 responses: {
 "200": {
 content: { "application/json": { html?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/exports": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 exportLocation?: string;
 repositoriesRequest: {
 includes: readonly { projectKey?: string; slug?: string }[];
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 endDate?: number;
 id?: number;
 initiator?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 nodeId?: string;
 progress?: { message?: string; percentage?: number };
 startDate?: number;
 state?:
 | "FAILED"
 | "COMPLETED"
 | "RUNNING"
 | "READY"
 | "INITIALISING"
 | "ABORTED"
 | "CANCELED"
 | "CANCELING"
 | "FINALISING"
 | "TIMED_OUT";
 type?: string;
 updatedDate?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "503": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/exports/{jobId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { jobId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 endDate?: number;
 id?: number;
 initiator?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 nodeId?: string;
 progress?: { message?: string; percentage?: number };
 startDate?: number;
 state?:
 | "FAILED"
 | "COMPLETED"
 | "RUNNING"
 | "READY"
 | "INITIALISING"
 | "ABORTED"
 | "CANCELED"
 | "CANCELING"
 | "FINALISING"
 | "TIMED_OUT";
 type?: string;
 updatedDate?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/exports/{jobId}/cancel": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { jobId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/exports/{jobId}/messages": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { jobId: string };
 query?: {
 limit?: number;
 severity?: string;
 start?: number;
 subject?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 createdDate?: string;
 id?: string;
 severity?: "ERROR"
 | "INFO"
 | "WARN";
 subject?: string;
 text?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/exports/preview": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 exportLocation?: string;
 repositoriesRequest: {
 includes: readonly { projectKey?: string; slug?: string }[];
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 links?: Record<string, unknown>;
 scopes?: readonly Record<string, unknown>[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/imports": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: { "application/json": { archivePath?: string } };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 endDate?: number;
 id?: number;
 initiator?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 nodeId?: string;
 progress?: { message?: string; percentage?: number };
 startDate?: number;
 state?:
 | "FAILED"
 | "COMPLETED"
 | "RUNNING"
 | "READY"
 | "INITIALISING"
 | "ABORTED"
 | "CANCELED"
 | "CANCELING"
 | "FINALISING"
 | "TIMED_OUT";
 type?: string;
 updatedDate?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "503": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/imports/{jobId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { jobId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 endDate?: number;
 id?: number;
 initiator?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 nodeId?: string;
 progress?: { message?: string; percentage?: number };
 startDate?: number;
 state?:
 | "FAILED"
 | "COMPLETED"
 | "RUNNING"
 | "READY"
 | "INITIALISING"
 | "ABORTED"
 | "CANCELED"
 | "CANCELING"
 | "FINALISING"
 | "TIMED_OUT";
 type?: string;
 updatedDate?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/imports/{jobId}/cancel": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { jobId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/imports/{jobId}/messages": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { jobId: string };
 query?: {
 limit?: number;
 severity?: string;
 start?: number;
 subject?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 createdDate?: string;
 id?: string;
 severity?: "ERROR"
 | "INFO"
 | "WARN";
 subject?: string;
 text?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/mesh": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 all?: boolean;
 maxBytesPerSecond?: { asLong?: number; present?: boolean };
 projectIds?: readonly number[];
 repositoryIds?: readonly number[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 endDate?: number;
 id?: number;
 initiator?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 nodeId?: string;
 progress?: { message?: string; percentage?: number };
 startDate?: number;
 state?:
 | "FAILED"
 | "COMPLETED"
 | "RUNNING"
 | "READY"
 | "INITIALISING"
 | "ABORTED"
 | "CANCELED"
 | "CANCELING"
 | "FINALISING"
 | "TIMED_OUT";
 type?: string;
 updatedDate?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "503": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/mesh/{jobId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { jobId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/mesh/{jobId}/cancel": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { jobId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/mesh/{jobId}/messages": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { jobId: string };
 query?: {
 limit?: number;
 severity?: string;
 start?: number;
 subject?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 createdDate?: string;
 id?: string;
 severity?: "ERROR"
 | "INFO"
 | "WARN";
 subject?: string;
 text?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/mesh/{jobId}/summary": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { jobId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 endTime?: number;
 jobId?: number;
 maxBandwidth?: number;
 progress?: number;
 queue?: Record<string, unknown>;
 startTime?: number;
 state?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/mesh/preview": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 all?: boolean;
 maxBytesPerSecond?: { asLong?: number; present?: boolean };
 projectIds?: readonly number[];
 repositoryIds?: readonly number[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 repositories?: readonly {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 origin?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 partition?: number;
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 public?: boolean;
 relatedLinks?: Record<(...), (...)>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/mesh/repos": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 limit?: number;
 migrationId?: string;
 name?: string;
 projectKey?: string;
 remote?: string;
 start?: number;
 state?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 migrationState?: | "FAILED"
 | "SKIPPED"
 | "CANCELED"
 | "MIGRATED"
 | "QUEUED"
 | "STAGED"
 | "STAGING";
 repository?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 origin?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/mesh/summaries": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 endTime?: number;
 jobId?: number;
 maxBandwidth?: number;
 progress?: number;
 queue?: Record<(...), (...)>;
 startTime?: number;
 state?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/migration/mesh/summary": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 endTime?: number;
 jobId?: number;
 maxBandwidth?: number;
 progress?: number;
 queue?: Record<string, unknown>;
 startTime?: number;
 state?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/profile/recent/repos": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { limit?: number; permission?: string; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 origin?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 partition?: number;
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 public?: boolean;
 relatedLinks?: Record<(...), (...)>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 limit?: number;
 name?: string;
 permission?: string;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key?: string;
 links?: Record<(...), (...)>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key?: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key?: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key?: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key?: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key?: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "201": {
 content: {
 "application/json": {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key?: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/avatar.png": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { s?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: { content: { "multipart/form-data": { avatar?: string } } };
 responses: {
 "201": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/hook-scripts": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 scope?: { resourceId?: ...; type?: ... };
 script?: {
 createdDate?: ...;
 description?: ...;
 id?: ...;
 name?: ...;
 pluginKey?: ...;
 type?: ...;
 updatedDate?: ...;
 version?: ...;
 };
 triggerIds?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/hook-scripts/{scriptId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; scriptId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; scriptId: string };
 query?: undefined;
 };
 requestBody?: {
 content: { "application/json": { triggerIds?: readonly string[] } };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 script?: {
 createdDate?: string;
 description?: string;
 id?: number;
 name?: string;
 pluginKey?: string;
 type?: "POST"
 | "PRE";
 updatedDate?: string;
 version?: number;
 };
 triggerIds?: readonly string[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/permissions": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { group?: string; user?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/permissions/{permission}/all": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { permission: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": { permitted?: boolean } };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { permission: string; projectKey: string };
 query?: { allow?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/permissions/groups": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { name?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { name?: string; permission?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/permissions/groups/none": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "202": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/permissions/search": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { filterText?: string; permission?: string; type?: string };
 };
 requestBody?: undefined;
 responses: {
 default: {
 content: { "application/json;charset=UTF-8": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/permissions/users": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { name?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { name?: string; permission?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/permissions/users/none": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 origin?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 partition?: number;
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 public?: boolean;
 relatedLinks?: Record<(...), (...)>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "202": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/archive": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 at?: string;
 filename?: string;
 format?: string;
 path?: string;
 prefix?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/attachments/{attachmentId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 attachmentId: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: { Range?: string; "User-Agent"?: string };
 path: {
 attachmentId: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "206": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/attachments/{attachmentId}/metadata": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 attachmentId: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 attachmentId: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 metadata?: string;
 url?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 attachmentId: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: { content: { "application/json": string } };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/branches": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 base?: string;
 boostMatches?: boolean;
 context?: string;
 details?: boolean;
 filterText?: string;
 limit?: number;
 orderBy?: "ALPHABETICAL" | "MODIFICATION";
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 default?: boolean;
 displayId?: string;
 id?: string;
 latestChangeset?: string;
 latestCommit?: string;
 type?: unknown;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 message?: string;
 name?: string;
 startPoint?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 default?: boolean;
 displayId?: string;
 id?: string;
 latestChangeset?: string;
 latestCommit?: string;
 type?: unknown;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/branches/default": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 default?: boolean;
 displayId?: string;
 id?: string;
 latestChangeset?: string;
 latestCommit?: string;
 type?: unknown;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 default?: boolean;
 displayId?: string;
 id?: string;
 latestChangeset?: string;
 latestCommit?: string;
 type?: unknown;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/browse": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 at?: string;
 blame?: string;
 noContent?: string;
 size?: string;
 type?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/browse/{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { path: string; projectKey: string; repositorySlug: string };
 query?: {
 at?: string;
 blame?: string;
 noContent?: string;
 size?: string;
 type?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { path: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "multipart/form-data": {
 branch?: string;
 content?: string;
 message?: string;
 sourceBranch?: string;
 sourceCommitId?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 author?: {
 avatarUrl?: string;
 emailAddress?: string;
 name?: string;
 };
 authorTimestamp?: number;
 committer?: {
 avatarUrl?: string;
 emailAddress?: string;
 name?: string;
 };
 committerTimestamp?: number;
 displayId?: string;
 id?: string;
 message?: string;
 parents?: readonly { displayId?: string; id?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/changes": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 limit?: number;
 since?: string;
 start?: number;
 until?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 conflict?: { ourChange?: ...; theirChange?: ... };
 contentId?: string;
 executable?: boolean;
 fromContentId?: string;
 links?: Record<(...), (...)>;
 nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE";
 path?: {
 components?: ...;
 extension?: ...;
 name?: ...;
 parent?: ...;
 };
 percentUnchanged?: number;
 srcExecutable?: boolean;
 srcPath?: {
 components?: ...;
 extension?: ...;
 name?: ...;
 parent?: ...;
 };
 type?: "UNKNOWN"
 | "DELETE"
 | "ADD"
 | "COPY"
 | "MODIFY"
 | "MOVE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 avatarScheme?: string;
 avatarSize?: string;
 followRenames?: string;
 ignoreMissing?: string;
 limit?: number;
 merges?: string;
 path?: string;
 since?: string;
 start?: number;
 until?: string;
 withCounts?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
 authorTimestamp?: number;
 committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
 committerTimestamp?: number;
 displayId?: string;
 id?: string;
 message?: string;
 parents?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: { path?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 author?: {
 avatarUrl?: string;
 emailAddress?: string;
 name?: string;
 };
 authorTimestamp?: number;
 committer?: {
 avatarUrl?: string;
 emailAddress?: string;
 name?: string;
 };
 committerTimestamp?: number;
 displayId?: string;
 id?: string;
 message?: string;
 parents?: readonly { displayId?: string; id?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/builds": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: { key?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query: { key: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 buildNumber?: string;
 createdDate?: number;
 description?: string;
 duration?: number;
 key?: string;
 name?: string;
 parent?: string;
 ref?: string;
 state?: | "FAILED"
 | "INPROGRESS"
 | "SUCCESSFUL"
 | "UNKNOWN"
 | "CANCELLED";
 testResults?: {
 failed?: number;
 skipped?: number;
 successful?: number;
 };
 updatedDate?: number;
 url?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "*/*": {
 buildNumber?: string;
 description?: string;
 duration?: number;
 key: string;
 lastUpdated?: number;
 name?: string;
 parent?: string;
 ref?: string;
 state: | "FAILED"
 | "INPROGRESS"
 | "SUCCESSFUL"
 | "UNKNOWN"
 | "CANCELLED";
 testResults?: {
 failed?: number;
 skipped?: number;
 successful?: number;
 };
 url: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/changes": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: {
 limit?: number;
 since?: string;
 start?: number;
 withComments?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 conflict?: { ourChange?: ...; theirChange?: ... };
 contentId?: string;
 executable?: boolean;
 fromContentId?: string;
 links?: Record<(...), (...)>;
 nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE";
 path?: {
 components?: ...;
 extension?: ...;
 name?: ...;
 parent?: ...;
 };
 percentUnchanged?: number;
 srcExecutable?: boolean;
 srcPath?: {
 components?: ...;
 extension?: ...;
 name?: ...;
 parent?: ...;
 };
 type?: "UNKNOWN"
 | "DELETE"
 | "ADD"
 | "COPY"
 | "MODIFY"
 | "MOVE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: {
 limit?: number;
 path?: string;
 since?: string;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 anchor?: {
 diffType?: ...;
 fileType?: ...;
 fromHash?: ...;
 line?: ...;
 lineType?: ...;
 multilineMarker?: ...;
 path?: ...;
 pullRequest?: ...;
 srcPath?: ...;
 toHash?: ...;
 };
 anchored?: boolean;
 author?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: ...;
 anchored?: ...;
 author?: ...;
 comments?: ...;
 createdDate?: ...;
 html?: ...;
 id?: ...;
 pending?: ...;
 properties?: ...;
 reply?: ...;
 resolvedDate?: ...;
 resolver?: ...;
 severity?: ...;
 state?: ...;
 text?: ...;
 threadResolved?: ...;
 threadResolvedDate?: ...;
 threadResolver?: ...;
 updatedDate?: ...;
 version?: ...;
 };
 pending?: boolean;
 properties?: Record<(...), (...)>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: { since?: string };
 };
 requestBody?: {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 commitId: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: { version?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 commitId: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 commitId: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/deployments": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: {
 deploymentSequenceNumber?: string;
 environmentKey?: string;
 key?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: {
 deploymentSequenceNumber?: string;
 environmentKey?: string;
 key?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 deploymentSequenceNumber?: number;
 description?: string;
 displayName?: string;
 environment?: {
 displayName: string;
 key: string;
 type?: string;
 url?: string;
 };
 fromCommit?: { displayId?: string; id?: string };
 key?: string;
 lastUpdated?: number;
 repository?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 state?: | "FAILED"
 | "SUCCESSFUL"
 | "IN_PROGRESS"
 | "PENDING"
 | "UNKNOWN"
 | "CANCELLED"
 | "ROLLED_BACK";
 toCommit?: { displayId?: string; id?: string };
 url?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "*/*": {
 deploymentSequenceNumber: number;
 description: string;
 displayName: string;
 environment: {
 displayName?: string;
 key?: string;
 type?: string;
 url?: string;
 };
 key: string;
 lastUpdated?: number;
 state: | "FAILED"
 | "SUCCESSFUL"
 | "IN_PROGRESS"
 | "PENDING"
 | "UNKNOWN"
 | "CANCELLED"
 | "ROLLED_BACK";
 url: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 deploymentSequenceNumber?: number;
 description?: string;
 displayName?: string;
 environment?: {
 displayName: string;
 key: string;
 type?: string;
 url?: string;
 };
 fromCommit?: { displayId?: string; id?: string };
 key?: string;
 lastUpdated?: number;
 repository?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 state?: | "FAILED"
 | "SUCCESSFUL"
 | "IN_PROGRESS"
 | "PENDING"
 | "UNKNOWN"
 | "CANCELLED"
 | "ROLLED_BACK";
 toCommit?: { displayId?: string; id?: string };
 url?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff-stats-summary/{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commitId: string;
 path: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: {
 autoSrcPath?: string;
 since?: string;
 srcPath?: string;
 whitespace?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff/{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commitId: string;
 path: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: {
 autoSrcPath?: string;
 avatarScheme?: string;
 avatarSize?: string;
 contextLines?: string;
 filter?: string;
 since?: string;
 srcPath?: string;
 whitespace?: string;
 withComments?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 binary?: boolean;
 destination?: {
 components?: readonly string[];
 extension?: string;
 name?: string;
 parent?: string;
 };
 hunks?: readonly {
 context?: string;
 destinationLine?: number;
 destinationSpan?: number;
 segments?: readonly (...)[];
 sourceLine?: number;
 sourceSpan?: number;
 truncated?: boolean;
 }[];
 lineComments?: readonly {
 anchor?: {
 diffType?: ...;
 fileType?: ...;
 fromHash?: ...;
 line?: ...;
 lineType?: ...;
 multilineMarker?: ...;
 path?: ...;
 pullRequest?: ...;
 srcPath?: ...;
 toHash?: ...;
 };
 anchored?: boolean;
 author?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: ...;
 anchored?: ...;
 author?: ...;
 comments?: ...;
 createdDate?: ...;
 html?: ...;
 id?: ...;
 pending?: ...;
 properties?: ...;
 reply?: ...;
 resolvedDate?: ...;
 resolver?: ...;
 severity?: ...;
 state?: ...;
 text?: ...;
 threadResolved?: ...;
 threadResolvedDate?: ...;
 threadResolver?: ...;
 updatedDate?: ...;
 version?: ...;
 };
 pending?: boolean;
 properties?: Record<(...), (...)>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 properties?: Record<string, unknown>;
 source?: {
 components?: readonly string[];
 extension?: string;
 name?: string;
 parent?: string;
 };
 truncated?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/merge-base": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: { otherCommitId?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 author?: {
 avatarUrl?: string;
 emailAddress?: string;
 name?: string;
 };
 authorTimestamp?: number;
 committer?: {
 avatarUrl?: string;
 emailAddress?: string;
 name?: string;
 };
 committerTimestamp?: number;
 displayId?: string;
 id?: string;
 message?: string;
 parents?: readonly { displayId?: string; id?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/pull-requests": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: ...;
 id?: ...;
 latestCommit?: ...;
 repository?: ...;
 type?: ...;
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<(...), (...)>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly (...)[];
 reviewers?: readonly (...)[];
 state?: "DECLINED" | "MERGED" | "OPEN";
 title?: string;
 toRef?: {
 displayId?: ...;
 id?: ...;
 latestCommit?: ...;
 repository?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/watch": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/changes": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 from?: string;
 fromRepo?: string;
 limit?: number;
 start?: number;
 to?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 conflict?: { ourChange?: ...; theirChange?: ... };
 contentId?: string;
 executable?: boolean;
 fromContentId?: string;
 links?: Record<(...), (...)>;
 nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE";
 path?: {
 components?: ...;
 extension?: ...;
 name?: ...;
 parent?: ...;
 };
 percentUnchanged?: number;
 srcExecutable?: boolean;
 srcPath?: {
 components?: ...;
 extension?: ...;
 name?: ...;
 parent?: ...;
 };
 type?: "UNKNOWN"
 | "DELETE"
 | "ADD"
 | "COPY"
 | "MODIFY"
 | "MOVE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/commits": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 from?: string;
 fromRepo?: string;
 limit?: number;
 start?: number;
 to?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
 authorTimestamp?: number;
 committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
 committerTimestamp?: number;
 displayId?: string;
 id?: string;
 message?: string;
 parents?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/diff-stats-summary{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { path: string; projectKey: string; repositorySlug: string };
 query?: {
 from?: string;
 fromRepo?: string;
 srcPath?: string;
 to?: string;
 whitespace?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 binary?: boolean;
 destination?: {
 components?: readonly string[];
 extension?: string;
 name?: string;
 parent?: string;
 };
 hunks?: readonly {
 context?: string;
 destinationLine?: number;
 destinationSpan?: number;
 segments?: readonly (...)[];
 sourceLine?: number;
 sourceSpan?: number;
 truncated?: boolean;
 }[];
 lineComments?: readonly {
 anchor?: {
 diffType?: ...;
 fileType?: ...;
 fromHash?: ...;
 line?: ...;
 lineType?: ...;
 multilineMarker?: ...;
 path?: ...;
 pullRequest?: ...;
 srcPath?: ...;
 toHash?: ...;
 };
 anchored?: boolean;
 author?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: ...;
 anchored?: ...;
 author?: ...;
 comments?: ...;
 createdDate?: ...;
 html?: ...;
 id?: ...;
 pending?: ...;
 properties?: ...;
 reply?: ...;
 resolvedDate?: ...;
 resolver?: ...;
 severity?: ...;
 state?: ...;
 text?: ...;
 threadResolved?: ...;
 threadResolvedDate?: ...;
 threadResolver?: ...;
 updatedDate?: ...;
 version?: ...;
 };
 pending?: boolean;
 properties?: Record<(...), (...)>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 properties?: Record<string, unknown>;
 source?: {
 components?: readonly string[];
 extension?: string;
 name?: string;
 parent?: string;
 };
 truncated?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/diff{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { path: string; projectKey: string; repositorySlug: string };
 query?: {
 contextLines?: string;
 from?: string;
 fromRepo?: string;
 srcPath?: string;
 to?: string;
 whitespace?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 binary?: boolean;
 destination?: {
 components?: readonly string[];
 extension?: string;
 name?: string;
 parent?: string;
 };
 hunks?: readonly {
 context?: string;
 destinationLine?: number;
 destinationSpan?: number;
 segments?: readonly (...)[];
 sourceLine?: number;
 sourceSpan?: number;
 truncated?: boolean;
 }[];
 lineComments?: readonly {
 anchor?: {
 diffType?: ...;
 fileType?: ...;
 fromHash?: ...;
 line?: ...;
 lineType?: ...;
 multilineMarker?: ...;
 path?: ...;
 pullRequest?: ...;
 srcPath?: ...;
 toHash?: ...;
 };
 anchored?: boolean;
 author?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: ...;
 anchored?: ...;
 author?: ...;
 comments?: ...;
 createdDate?: ...;
 html?: ...;
 id?: ...;
 pending?: ...;
 properties?: ...;
 reply?: ...;
 resolvedDate?: ...;
 resolver?: ...;
 severity?: ...;
 state?: ...;
 text?: ...;
 threadResolved?: ...;
 threadResolvedDate?: ...;
 threadResolver?: ...;
 updatedDate?: ...;
 version?: ...;
 };
 pending?: boolean;
 properties?: Record<(...), (...)>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 properties?: Record<string, unknown>;
 source?: {
 components?: readonly string[];
 extension?: string;
 name?: string;
 parent?: string;
 };
 truncated?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/contributing": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 at?: string;
 hardwrap?: string;
 htmlEscape?: string;
 includeHeadingId?: string;
 markup?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/default-branch": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 displayId?: string;
 id?: string;
 type?: "BRANCH"
 | "TAG";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 default?: boolean;
 displayId?: string;
 id?: string;
 latestChangeset?: string;
 latestCommit?: string;
 type?: unknown;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/diff": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 contextLines?: string;
 since?: string;
 srcPath?: string;
 until?: string;
 whitespace?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/diff/{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { path: string; projectKey: string; repositorySlug: string };
 query?: {
 contextLines?: string;
 since?: string;
 srcPath?: string;
 until?: string;
 whitespace?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/files": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { at?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly unknown[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/files/{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { path: string; projectKey: string; repositorySlug: string };
 query?: { at?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly unknown[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/forks": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 origin?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 partition?: number;
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 public?: boolean;
 relatedLinks?: Record<(...), (...)>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/hook-scripts": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 scope?: { resourceId?: ...; type?: ... };
 script?: {
 createdDate?: ...;
 description?: ...;
 id?: ...;
 name?: ...;
 pluginKey?: ...;
 type?: ...;
 updatedDate?: ...;
 version?: ...;
 };
 triggerIds?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/hook-scripts/{scriptId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; scriptId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; scriptId: string };
 query?: undefined;
 };
 requestBody?: {
 content: { "application/json": { triggerIds?: readonly string[] } };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 script?: {
 createdDate?: string;
 description?: string;
 id?: number;
 name?: string;
 pluginKey?: string;
 type?: "POST"
 | "PRE";
 updatedDate?: string;
 version?: number;
 };
 triggerIds?: readonly string[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/labels": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": { name?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: { content: { "application/json": { name?: string } } };
 responses: {
 "200": {
 content: { "application/json": { name?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/labels/{labelName}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { labelName: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/last-modified": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { at?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 files?: {
 latestCommit?: {
 author?: (...)
 | (...);
 authorTimestamp?: (...) | (...);
 committer?: (...) | (...);
 committerTimestamp?: (...) | (...);
 displayId?: (...) | (...);
 id?: (...) | (...);
 message?: (...) | (...);
 parents?: (...) | (...);
 };
 pomXml?: {
 author?: (...)
 | (...);
 authorTimestamp?: (...) | (...);
 committer?: (...) | (...);
 committerTimestamp?: (...) | (...);
 displayId?: (...) | (...);
 id?: (...) | (...);
 message?: (...) | (...);
 parents?: (...) | (...);
 };
 readmeMd?: {
 author?: (...)
 | (...);
 authorTimestamp?: (...) | (...);
 committer?: (...) | (...);
 committerTimestamp?: (...) | (...);
 displayId?: (...) | (...);
 id?: (...) | (...);
 message?: (...) | (...);
 parents?: (...) | (...);
 };
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/last-modified/{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { path: string; projectKey: string; repositorySlug: string };
 query?: { at?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 files?: {
 latestCommit?: {
 author?: (...)
 | (...);
 authorTimestamp?: (...) | (...);
 committer?: (...) | (...);
 committerTimestamp?: (...) | (...);
 displayId?: (...) | (...);
 id?: (...) | (...);
 message?: (...) | (...);
 parents?: (...) | (...);
 };
 pomXml?: {
 author?: (...)
 | (...);
 authorTimestamp?: (...) | (...);
 committer?: (...) | (...);
 committerTimestamp?: (...) | (...);
 displayId?: (...) | (...);
 id?: (...) | (...);
 message?: (...) | (...);
 parents?: (...) | (...);
 };
 readmeMd?: {
 author?: (...)
 | (...);
 authorTimestamp?: (...) | (...);
 committer?: (...) | (...);
 committerTimestamp?: (...) | (...);
 displayId?: (...) | (...);
 id?: (...) | (...);
 message?: (...) | (...);
 parents?: (...) | (...);
 };
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/license": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 at?: string;
 hardwrap?: string;
 htmlEscape?: string;
 includeHeadingId?: string;
 markup?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/participants": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 direction?: string;
 filter?: string;
 limit?: number;
 role?: string;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/patch": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { allAncestors?: string; since?: string; until?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { group?: string; user?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/groups": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query: {
 name: readonly string[];
 permission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE";
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/groups/none": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/search": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { filterText?: string; permission?: string; type?: string };
 };
 requestBody?: undefined;
 responses: {
 default: {
 content: { "application/json;charset=UTF-8": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/users": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query: {
 name: readonly string[];
 permission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE";
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/users/none": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 at?: string;
 direction?: string;
 draft?: string;
 filterText?: string;
 limit?: number;
 order?: string;
 start?: number;
 state?: string;
 withAttributes?: string;
 withProperties?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: ...;
 id?: ...;
 latestCommit?: ...;
 repository?: ...;
 type?: ...;
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<(...), (...)>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly (...)[];
 reviewers?: readonly (...)[];
 state?: "DECLINED" | "MERGED" | "OPEN";
 title?: string;
 toRef?: {
 displayId?: ...;
 id?: ...;
 latestCommit?: ...;
 repository?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...)
 | (...)
 | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<string, unknown>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 reviewers?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 state?: "DECLINED"
 | "MERGED"
 | "OPEN";
 title?: string;
 toRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...)
 | (...)
 | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<string, unknown>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 reviewers?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 state?: "DECLINED"
 | "MERGED"
 | "OPEN";
 title?: string;
 toRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: { content: { "application/json": { version?: number } } };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...)
 | (...)
 | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<string, unknown>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 reviewers?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 state?: "DECLINED"
 | "MERGED"
 | "OPEN";
 title?: string;
 toRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...)
 | (...)
 | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<string, unknown>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 reviewers?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 state?: "DECLINED"
 | "MERGED"
 | "OPEN";
 title?: string;
 toRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...)
 | (...)
 | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<string, unknown>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 reviewers?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 state?: "DECLINED"
 | "MERGED"
 | "OPEN";
 title?: string;
 toRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}.diff": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: { contextLines?: string; whitespace?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "text/plain": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: { "text/html": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: { "text/html": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}.patch": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/activities": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: {
 fromId?: string;
 fromType?: string;
 limit?: number;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 action?: | "DECLINED"
 | "MERGED"
 | "APPROVED"
 | "UNAPPROVED"
 | "AUTO_MERGE_CANCELLED"
 | "AUTO_MERGE_REQUESTED"
 | "COMMENTED"
 | "DELETED"
 | "OPENED"
 | "REOPENED"
 | "RESCOPED"
 | "REVIEW_COMMENTED"
 | "REVIEW_DISCARDED"
 | "REVIEW_FINISHED"
 | "REVIEWED"
 | "UPDATED";
 createdDate?: number;
 id?: number;
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/approve": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/auto-merge": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 autoSubject?: boolean;
 createdDate?: number;
 fromHash?: string;
 message?: string;
 strategyId?: string;
 toRefId?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 autoMergeProcessingStatus?: | "MERGED"
 | "UNKNOWN"
 | "CANCELLED"
 | "LOCK_FAILURE"
 | "STALE"
 | "VETOED";
 pullRequest?: {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: (...)
 | (...);
 id?: (...) | (...);
 latestCommit?: (...) | (...);
 repository?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<string, unknown>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly {
 approved?: ...;
 lastReviewedCommit?: ...;
 role?: ...;
 status?: ...;
 user?: ...;
 }[];
 reviewers?: readonly {
 approved?: ...;
 lastReviewedCommit?: ...;
 role?: ...;
 status?: ...;
 user?: ...;
 }[];
 state?: "DECLINED"
 | "MERGED"
 | "OPEN";
 title?: string;
 toRef?: {
 displayId?: (...) | (...);
 id?: (...) | (...);
 latestCommit?: (...) | (...);
 repository?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: {
 count?: string;
 limit?: number;
 start?: number;
 state?: readonly string[];
 states?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 anchor?: {
 diffType?: ...;
 fileType?: ...;
 fromHash?: ...;
 line?: ...;
 lineType?: ...;
 multilineMarker?: ...;
 path?: ...;
 pullRequest?: ...;
 srcPath?: ...;
 toHash?: ...;
 };
 anchored?: boolean;
 author?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: ...;
 anchored?: ...;
 author?: ...;
 comments?: ...;
 createdDate?: ...;
 html?: ...;
 id?: ...;
 pending?: ...;
 properties?: ...;
 reply?: ...;
 resolvedDate?: ...;
 resolver?: ...;
 severity?: ...;
 state?: ...;
 text?: ...;
 threadResolved?: ...;
 threadResolvedDate?: ...;
 threadResolver?: ...;
 updatedDate?: ...;
 version?: ...;
 };
 pending?: boolean;
 properties?: Record<(...), (...)>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments/{commentId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: { version?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/changes": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: {
 changeScope?: string;
 limit?: number;
 sinceId?: string;
 start?: number;
 untilId?: string;
 withComments?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 conflict?: {
 ourChange?: {
 path?: (...)
 | (...);
 srcPath?: (...) | (...);
 type?: (...) | (...) | (...) | (...) | (...) | (...) | (...);
 };
 theirChange?: {
 path?: (...)
 | (...);
 srcPath?: (...) | (...);
 type?: (...) | (...) | (...) | (...) | (...) | (...) | (...);
 };
 };
 contentId?: string;
 executable?: boolean;
 fromContentId?: string;
 links?: Record<string, unknown>;
 nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE";
 path?: {
 components?: readonly string[];
 extension?: string;
 name?: string;
 parent?: string;
 };
 percentUnchanged?: number;
 srcExecutable?: boolean;
 srcPath?: {
 components?: readonly string[];
 extension?: string;
 name?: string;
 parent?: string;
 };
 type?: "UNKNOWN"
 | "DELETE"
 | "ADD"
 | "COPY"
 | "MODIFY"
 | "MOVE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query: {
 anchorState?: string;
 diffType?: readonly string[];
 diffTypes?: string;
 fromHash?: string;
 limit?: number;
 path: string;
 start?: number;
 state?: readonly string[];
 states?: string;
 toHash?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 anchor?: {
 diffType?: ...;
 fileType?: ...;
 fromHash?: ...;
 line?: ...;
 lineType?: ...;
 multilineMarker?: ...;
 path?: ...;
 pullRequest?: ...;
 srcPath?: ...;
 toHash?: ...;
 };
 anchored?: boolean;
 author?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: ...;
 anchored?: ...;
 author?: ...;
 comments?: ...;
 createdDate?: ...;
 html?: ...;
 id?: ...;
 pending?: ...;
 properties?: ...;
 reply?: ...;
 resolvedDate?: ...;
 resolver?: ...;
 severity?: ...;
 state?: ...;
 text?: ...;
 threadResolved?: ...;
 threadResolvedDate?: ...;
 threadResolver?: ...;
 updatedDate?: ...;
 version?: ...;
 };
 pending?: boolean;
 properties?: Record<(...), (...)>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: { version?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 anchor?: {
 diffType?: "COMMIT"
 | "EFFECTIVE"
 | "RANGE";
 fileType?: "FROM" | "TO";
 fromHash?: string;
 line?: number;
 lineType?: "ADDED" | "CONTEXT" | "REMOVED";
 multilineMarker?: {
 startLine?: (...) | (...);
 startLineType: (...) | (...) | (...);
 };
 path?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 pullRequest?: {
 closed?: (...)
 | (...)
 | (...);
 closedDate?: (...) | (...);
 createdDate?: (...) | (...);
 description?: (...) | (...);
 descriptionAsHtml?: (...) | (...);
 draft?: (...) | (...) | (...);
 fromRef?: (...) | (...);
 htmlDescription?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 locked?: (...) | (...) | (...);
 open?: (...) | (...) | (...);
 participants?: (...) | (...);
 reviewers?: (...) | (...);
 state?: (...) | (...) | (...) | (...);
 title?: (...) | (...);
 toRef?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 srcPath?: {
 components?: (...)
 | (...);
 extension?: (...) | (...);
 name?: (...) | (...);
 parent?: (...) | (...);
 };
 toHash?: string;
 };
 anchored?: boolean;
 author?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly (
 { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
 )[];
 createdDate?: number;
 html?: string;
 id?: number;
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/apply-suggestion": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 commentVersion?: { asInt?: number; present?: boolean };
 commitMessage?: string;
 pullRequestVersion?: { asInt?: number; present?: boolean };
 suggestionIndex?: { asInt?: number; present?: boolean };
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commit-message-suggestion": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": { body?: string; title?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commits": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: {
 avatarScheme?: string;
 avatarSize?: string;
 limit?: number;
 start?: number;
 withCounts?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
 authorTimestamp?: number;
 committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
 committerTimestamp?: number;
 displayId?: string;
 id?: string;
 message?: string;
 parents?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/decline": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: { version?: string };
 };
 requestBody?: {
 content: {
 "application/json": { comment?: string; version?: number };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...)
 | (...)
 | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<string, unknown>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 reviewers?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 state?: "DECLINED"
 | "MERGED"
 | "OPEN";
 title?: string;
 toRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff-stats-summary/{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 path: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: {
 sinceId?: string;
 srcPath?: string;
 untilId?: string;
 whitespace?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff/{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 path: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: {
 avatarScheme?: string;
 avatarSize?: string;
 contextLines?: string;
 diffType?: string;
 sinceId?: string;
 srcPath?: string;
 untilId?: string;
 whitespace?: string;
 withComments?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 binary?: boolean;
 destination?: {
 components?: readonly string[];
 extension?: string;
 name?: string;
 parent?: string;
 };
 hunks?: readonly {
 context?: string;
 destinationLine?: number;
 destinationSpan?: number;
 segments?: readonly (...)[];
 sourceLine?: number;
 sourceSpan?: number;
 truncated?: boolean;
 }[];
 lineComments?: readonly {
 anchor?: {
 diffType?: ...;
 fileType?: ...;
 fromHash?: ...;
 line?: ...;
 lineType?: ...;
 multilineMarker?: ...;
 path?: ...;
 pullRequest?: ...;
 srcPath?: ...;
 toHash?: ...;
 };
 anchored?: boolean;
 author?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: ...;
 anchored?: ...;
 author?: ...;
 comments?: ...;
 createdDate?: ...;
 html?: ...;
 id?: ...;
 pending?: ...;
 properties?: ...;
 reply?: ...;
 resolvedDate?: ...;
 resolver?: ...;
 severity?: ...;
 state?: ...;
 text?: ...;
 threadResolved?: ...;
 threadResolvedDate?: ...;
 threadResolver?: ...;
 updatedDate?: ...;
 version?: ...;
 };
 pending?: boolean;
 properties?: Record<(...), (...)>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 properties?: Record<string, unknown>;
 source?: {
 components?: readonly string[];
 extension?: string;
 name?: string;
 parent?: string;
 };
 truncated?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 conflicted?: boolean;
 outcome?: "UNKNOWN"
 | "CLEAN"
 | "CONFLICTED";
 vetoes?: readonly {
 detailedMessage?: string;
 summaryMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: { version?: string };
 };
 requestBody?: {
 content: {
 "application/json": {
 autoMerge?: boolean;
 autoSubject?: string;
 message?: string;
 strategyId?: string;
 version?: number;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...)
 | (...)
 | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<string, unknown>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 reviewers?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 state?: "DECLINED"
 | "MERGED"
 | "OPEN";
 title?: string;
 toRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge-base": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 author?: {
 avatarUrl?: string;
 emailAddress?: string;
 name?: string;
 };
 authorTimestamp?: number;
 committer?: {
 avatarUrl?: string;
 emailAddress?: string;
 name?: string;
 };
 committerTimestamp?: number;
 displayId?: string;
 id?: string;
 message?: string;
 parents?: readonly { displayId?: string; id?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: { username?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody: {
 content: {
 "application/json": {
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 userSlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 userSlug: string;
 };
 query?: { version?: string };
 };
 requestBody: {
 content: {
 "application/json": {
 lastReviewedCommit?: string;
 status?: "APPROVED"
 | "NEEDS_WORK"
 | "UNAPPROVED";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/reopen": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: { version?: string };
 };
 requestBody?: { content: { "application/json": { version?: number } } };
 responses: {
 "200": {
 content: {
 "application/json": {
 closed?: boolean;
 closedDate?: number;
 createdDate?: number;
 description?: string;
 descriptionAsHtml?: string;
 draft?: boolean;
 fromRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 htmlDescription?: string;
 id?: number;
 links?: Record<string, unknown>;
 locked?: boolean;
 open?: boolean;
 participants?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 reviewers?: readonly {
 approved?: boolean;
 lastReviewedCommit?: string;
 role?: "PARTICIPANT"
 | "REVIEWER"
 | "AUTHOR";
 status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 state?: "DECLINED"
 | "MERGED"
 | "OPEN";
 title?: string;
 toRef?: {
 displayId?: string;
 id?: string;
 latestCommit?: string;
 repository?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 origin?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 type?: "BRANCH"
 | "TAG";
 };
 updatedDate?: number;
 version?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/review": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 anchor?: {
 diffType?: ...;
 fileType?: ...;
 fromHash?: ...;
 line?: ...;
 lineType?: ...;
 multilineMarker?: ...;
 path?: ...;
 pullRequest?: ...;
 srcPath?: ...;
 toHash?: ...;
 };
 anchored?: boolean;
 author?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: ...;
 anchored?: ...;
 author?: ...;
 comments?: ...;
 createdDate?: ...;
 html?: ...;
 id?: ...;
 pending?: ...;
 properties?: ...;
 reply?: ...;
 resolvedDate?: ...;
 resolver?: ...;
 severity?: ...;
 state?: ...;
 text?: ...;
 threadResolved?: ...;
 threadResolvedDate?: ...;
 threadResolver?: ...;
 updatedDate?: ...;
 version?: ...;
 };
 pending?: boolean;
 properties?: Record<(...), (...)>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 updatedDate?: number;
 version?: number;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: { version?: string };
 };
 requestBody?: {
 content: {
 "application/json": {
 commentText?: string;
 lastReviewedCommit?: string;
 participantStatus?: string;
 };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/raw/{path}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { path: string; projectKey: string; repositorySlug: string };
 query?: {
 at?: string;
 hardwrap?: string;
 htmlEscape?: string;
 includeHeadingId?: string;
 markup?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/readme": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 at?: string;
 hardwrap?: string;
 htmlEscape?: string;
 includeHeadingId?: string;
 markup?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/recreate": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/ref-change-activities": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; ref?: string; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 createdDate?: number;
 id?: number;
 refChange?: {
 fromHash?: ...;
 ref?: ...;
 refId?: ...;
 toHash?: ...;
 type?: ...;
 updatedType?: ...;
 };
 repository?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 origin?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 trigger?: string;
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/ref-change-activities/branches": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { filterText?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 displayId?: string;
 id?: string;
 type?: "BRANCH"
 | "TAG";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/related": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 origin?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 partition?: number;
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 public?: boolean;
 relatedLinks?: Record<(...), (...)>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 filter?: string;
 limit?: number;
 order?: "NAME_ASC" | "NAME_DESC";
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/exempt": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 filter?: string;
 limit?: number;
 order?: "NAME_ASC" | "NAME_DESC";
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: { resourceId?: ...; type?: ... };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/auto-decline": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 enabled?: boolean;
 inactivityWeeks?: number;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { enabled?: boolean; inactivityWeeks?: number };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 enabled?: boolean;
 inactivityWeeks?: number;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/auto-merge": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 enabled?: boolean;
 restrictionState?: | "NONE"
 | "RESTRICTED_MODIFIABLE"
 | "RESTRICTED_UNMODIFIABLE";
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: { content: { "application/json": { enabled?: boolean } } };
 responses: {
 "200": {
 content: {
 "application/json": {
 enabled?: boolean;
 restrictionState?:
 | "NONE"
 | "RESTRICTED_MODIFIABLE"
 | "RESTRICTED_UNMODIFIABLE";
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 limit?: number;
 start?: number;
 type?: "POST_RECEIVE" | "PRE_RECEIVE";
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 configured?: boolean;
 details?: {
 configFormKey?: ...;
 description?: ...;
 key?: ...;
 name?: ...;
 supportedScopes?: ...;
 type?: ...;
 version?: ...;
 };
 enabled?: boolean;
 scope?: { resourceId?: ...; type?: ... };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { hookKey: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { hookKey: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 configured?: boolean;
 details?: {
 configFormKey?: string;
 description?: string;
 key?: string;
 name?: string;
 supportedScopes?: readonly ((...) | (...) | (...))[];
 type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
 version?: string;
 };
 enabled?: boolean;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { hookKey: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 configured?: boolean;
 details?: {
 configFormKey?: string;
 description?: string;
 key?: string;
 name?: string;
 supportedScopes?: readonly ((...) | (...) | (...))[];
 type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
 version?: string;
 };
 enabled?: boolean;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: { "Content-Length"?: string };
 path: { hookKey: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 configured?: boolean;
 details?: {
 configFormKey?: string;
 description?: string;
 key?: string;
 name?: string;
 supportedScopes?: readonly ((...) | (...) | (...))[];
 type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
 version?: string;
 };
 enabled?: boolean;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { hookKey: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 booleanValue?: boolean;
 doubleValue?: number;
 integerValue?: number;
 longValue?: number;
 stringValue?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { hookKey: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 booleanValue?: boolean;
 doubleValue?: number;
 integerValue?: number;
 longValue?: number;
 stringValue?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 booleanValue?: boolean;
 doubleValue?: number;
 integerValue?: number;
 longValue?: number;
 stringValue?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 mergeConfig?: {
 commitMessageTemplate?: {
 body?: (...)
 | (...);
 title?: (...) | (...);
 };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: (...)
 | (...);
 enabled?: (...) | (...) | (...);
 flag?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 };
 strategies?: readonly {
 description?: ...;
 enabled?: ...;
 flag?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 }[];
 type?: string;
 };
 requiredAllApprovers?: boolean;
 requiredAllTasksComplete?: boolean;
 requiredApprovers?: { count?: string; enabled?: boolean };
 requiredApproversDeprecated?: number;
 requiredSuccessfulBuilds?: { count?: string; enabled?: boolean };
 requiredSuccessfulBuildsDeprecated?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 mergeConfig?: {
 commitMessageTemplate?: {
 body?: (...)
 | (...);
 title?: (...) | (...);
 };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: (...)
 | (...);
 enabled?: (...) | (...) | (...);
 flag?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 };
 strategies?: readonly {
 description?: ...;
 enabled?: ...;
 flag?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 }[];
 type?: string;
 };
 requiredAllApprovers?: boolean;
 requiredAllTasksComplete?: boolean;
 requiredApprovers?: { count?: string; enabled?: boolean };
 requiredApproversDeprecated?: number;
 requiredSuccessfulBuilds?: { count?: string; enabled?: boolean };
 requiredSuccessfulBuildsDeprecated?: number;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 mergeConfig?: {
 commitMessageTemplate?: {
 body?: (...)
 | (...);
 title?: (...) | (...);
 };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: (...)
 | (...);
 enabled?: (...) | (...) | (...);
 flag?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 };
 strategies?: readonly {
 description?: ...;
 enabled?: ...;
 flag?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 }[];
 type?: string;
 };
 requiredAllApprovers?: boolean;
 requiredAllTasksComplete?: boolean;
 requiredApprovers?: { count?: string; enabled?: boolean };
 requiredApproversDeprecated?: number;
 requiredSuccessfulBuilds?: { count?: string; enabled?: boolean };
 requiredSuccessfulBuildsDeprecated?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: { resourceId?: ...; type?: ... };
 users?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 users?: readonly {
 active?: boolean;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 name?: string;
 slug?: string;
 type?: "NORMAL"
 | "SERVICE";
 }[];
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 users?: readonly {
 active?: boolean;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 name?: string;
 slug?: string;
 type?: "NORMAL"
 | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 users?: readonly {
 active?: boolean;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 name?: string;
 slug?: string;
 type?: "NORMAL"
 | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 users?: readonly {
 active?: boolean;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 name?: string;
 slug?: string;
 type?: "NORMAL"
 | "SERVICE";
 }[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 users?: readonly {
 active?: boolean;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 name?: string;
 slug?: string;
 type?: "NORMAL"
 | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}/users": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json;charset=UTF-8": readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json;charset=UTF-8": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json;charset=UTF-8": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/tags": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 filterText?: string;
 limit?: number;
 orderBy?: string;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 displayId?: string;
 hash?: string;
 id?: string;
 latestChangeset?: string;
 latestCommit?: string;
 type?: "BRANCH"
 | "TAG";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 message?: string;
 name?: string;
 startPoint?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 displayId?: string;
 hash?: string;
 id?: string;
 latestChangeset?: string;
 latestCommit?: string;
 type?: "BRANCH"
 | "TAG";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/tags/{name}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { name: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 displayId?: string;
 hash?: string;
 id?: string;
 latestChangeset?: string;
 latestCommit?: string;
 type?: "BRANCH"
 | "TAG";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/watch": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { event?: string; statistics?: boolean };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 active?: boolean;
 configuration?: Record<string, unknown>;
 credentials?: { password?: string; username?: string };
 events?: readonly string[];
 name?: string;
 scopeType?: string;
 sslVerificationRequired?: boolean;
 statistics?: Record<string, unknown>;
 url?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 configuration?: Record<string, unknown>;
 credentials?: { password?: string; username?: string };
 events?: readonly string[];
 name?: string;
 scopeType?: string;
 sslVerificationRequired?: boolean;
 statistics?: Record<string, unknown>;
 url?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; webhookId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; webhookId: string };
 query?: { statistics?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 configuration?: Record<string, unknown>;
 credentials?: { password?: string; username?: string };
 events?: readonly string[];
 name?: string;
 scopeType?: string;
 sslVerificationRequired?: boolean;
 statistics?: Record<string, unknown>;
 url?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; webhookId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 active?: boolean;
 configuration?: Record<string, unknown>;
 credentials?: { password?: string; username?: string };
 events?: readonly string[];
 name?: string;
 scopeType?: string;
 sslVerificationRequired?: boolean;
 statistics?: Record<string, unknown>;
 url?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 configuration?: Record<string, unknown>;
 credentials?: { password?: string; username?: string };
 events?: readonly string[];
 name?: string;
 scopeType?: string;
 sslVerificationRequired?: boolean;
 statistics?: Record<string, unknown>;
 url?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/latest": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; webhookId: string };
 query?: { event?: string; outcome?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 duration?: number;
 event?: string;
 eventScope?: { id?: string; type?: string };
 finish?: number;
 id?: number;
 request?: Record<string, unknown>;
 result?: Record<string, unknown>;
 start?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; webhookId: string };
 query?: { event?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics/summary": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; webhookId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/search": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { event?: string; scopeType?: string; statistics?: boolean };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/test": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 sslVerificationRequired?: string;
 url?: string;
 webhookId?: number;
 };
 };
 requestBody?: {
 content: {
 "application/json": { password?: string; username?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/secret-scanning/allowlist": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: {
 filter?: string;
 limit?: number;
 order?: "NAME_ASC" | "NAME_DESC";
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/secret-scanning/allowlist/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/secret-scanning/exempt": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 limit?: number;
 order?: "NAME_ASC"
 | "NAME_DESC";
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 origin?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 partition?: number;
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 public?: boolean;
 relatedLinks?: Record<(...), (...)>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: { "*/*": readonly { projectKey?: string; slug?: string }[] };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/secret-scanning/rules": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: {
 filter?: string;
 limit?: number;
 order?: "NAME_ASC" | "NAME_DESC";
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: { resourceId?: ...; type?: ... };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/secret-scanning/rules/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings-restriction": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query: { componentKey?: string; featureKey: string; namespace: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query: { componentKey?: string; featureKey: string; namespace: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 componentKey?: string;
 featureKey?: string;
 namespace?: string;
 processedState?: | "FAILED"
 | "IN_PROGRESS"
 | "PROCESSED"
 | "UNPROCESSED";
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "application/json": {
 componentKey?: string;
 featureKey: string;
 namespace: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 componentKey?: string;
 featureKey?: string;
 namespace?: string;
 processedState?: | "FAILED"
 | "IN_PROGRESS"
 | "PROCESSED"
 | "UNPROCESSED";
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings-restriction/all": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query: {
 featureKey: string;
 limit?: number;
 namespace: string;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 componentKey?: string;
 featureKey?: string;
 namespace?: string;
 processedState?: | "FAILED"
 | "IN_PROGRESS"
 | "PROCESSED"
 | "UNPROCESSED";
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings/auto-decline": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 enabled?: boolean;
 inactivityWeeks?: number;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { enabled?: boolean; inactivityWeeks?: number };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 enabled?: boolean;
 inactivityWeeks?: number;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings/auto-merge": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 enabled?: boolean;
 restrictionState?: | "NONE"
 | "RESTRICTED_MODIFIABLE"
 | "RESTRICTED_UNMODIFIABLE";
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 enabled?: boolean;
 restrictionAction?: "CREATE"
 | "DELETE"
 | "NONE";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 enabled?: boolean;
 restrictionState?: | "NONE"
 | "RESTRICTED_MODIFIABLE"
 | "RESTRICTED_UNMODIFIABLE";
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings/hooks": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: {
 limit?: number;
 start?: number;
 type?: "POST_RECEIVE" | "PRE_RECEIVE";
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 configured?: boolean;
 details?: {
 configFormKey?: ...;
 description?: ...;
 key?: ...;
 name?: ...;
 supportedScopes?: ...;
 type?: ...;
 version?: ...;
 };
 enabled?: boolean;
 scope?: { resourceId?: ...; type?: ... };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings/hooks/{hookKey}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { hookKey: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 configured?: boolean;
 details?: {
 configFormKey?: string;
 description?: string;
 key?: string;
 name?: string;
 supportedScopes?: readonly ((...) | (...) | (...))[];
 type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
 version?: string;
 };
 enabled?: boolean;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings/hooks/{hookKey}/enabled": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { hookKey: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 configured?: boolean;
 details?: {
 configFormKey?: string;
 description?: string;
 key?: string;
 name?: string;
 supportedScopes?: readonly ((...) | (...) | (...))[];
 type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
 version?: string;
 };
 enabled?: boolean;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: { "Content-Length"?: number };
 path: { hookKey: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 configured?: boolean;
 details?: {
 configFormKey?: string;
 description?: string;
 key?: string;
 name?: string;
 supportedScopes?: readonly ((...) | (...) | (...))[];
 type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
 version?: string;
 };
 enabled?: boolean;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings/hooks/{hookKey}/settings": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { hookKey: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 booleanValue?: boolean;
 doubleValue?: number;
 integerValue?: number;
 longValue?: number;
 stringValue?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { hookKey: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 booleanValue?: boolean;
 doubleValue?: number;
 integerValue?: number;
 longValue?: number;
 stringValue?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 booleanValue?: boolean;
 doubleValue?: number;
 integerValue?: number;
 longValue?: number;
 stringValue?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings/pull-requests/{scmId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; scmId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 mergeConfig?: {
 commitMessageTemplate?: {
 body?: (...)
 | (...);
 title?: (...) | (...);
 };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: (...)
 | (...);
 enabled?: (...) | (...) | (...);
 flag?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 };
 strategies?: readonly {
 description?: ...;
 enabled?: ...;
 flag?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 }[];
 type?: string;
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; scmId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 mergeConfig?: {
 commitMessageTemplate?: {
 body?: (...)
 | (...);
 title?: (...) | (...);
 };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: (...)
 | (...);
 enabled?: (...) | (...) | (...);
 flag?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 };
 strategies?: readonly {
 description?: ...;
 enabled?: ...;
 flag?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 }[];
 type?: string;
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 mergeConfig?: {
 commitMessageTemplate?: {
 body?: (...)
 | (...);
 title?: (...) | (...);
 };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: (...)
 | (...);
 enabled?: (...) | (...) | (...);
 flag?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 };
 strategies?: readonly {
 description?: ...;
 enabled?: ...;
 flag?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 }[];
 type?: string;
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings/reviewer-groups": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: { resourceId?: ...; type?: ... };
 users?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 users?: readonly {
 active?: boolean;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 name?: string;
 slug?: string;
 type?: "NORMAL"
 | "SERVICE";
 }[];
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 users?: readonly {
 active?: boolean;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 name?: string;
 slug?: string;
 type?: "NORMAL"
 | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/settings/reviewer-groups/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 users?: readonly {
 active?: boolean;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 name?: string;
 slug?: string;
 type?: "NORMAL"
 | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 users?: readonly {
 active?: boolean;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 name?: string;
 slug?: string;
 type?: "NORMAL"
 | "SERVICE";
 }[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 avatarUrl?: string;
 description?: string;
 id?: number;
 name?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 users?: readonly {
 active?: boolean;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 name?: string;
 slug?: string;
 type?: "NORMAL"
 | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/webhooks": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { event?: string; statistics?: boolean };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 active?: boolean;
 configuration?: Record<string, unknown>;
 credentials?: { password?: string; username?: string };
 events?: readonly string[];
 name?: string;
 scopeType?: string;
 sslVerificationRequired?: boolean;
 statistics?: Record<string, unknown>;
 url?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 configuration?: Record<string, unknown>;
 credentials?: { password?: string; username?: string };
 events?: readonly string[];
 name?: string;
 scopeType?: string;
 sslVerificationRequired?: boolean;
 statistics?: Record<string, unknown>;
 url?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/webhooks/{webhookId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; webhookId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; webhookId: string };
 query?: { statistics?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 configuration?: Record<string, unknown>;
 credentials?: { password?: string; username?: string };
 events?: readonly string[];
 name?: string;
 scopeType?: string;
 sslVerificationRequired?: boolean;
 statistics?: Record<string, unknown>;
 url?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; webhookId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 active?: boolean;
 configuration?: Record<string, unknown>;
 credentials?: { password?: string; username?: string };
 events?: readonly string[];
 name?: string;
 scopeType?: string;
 sslVerificationRequired?: boolean;
 statistics?: Record<string, unknown>;
 url?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 configuration?: Record<string, unknown>;
 credentials?: { password?: string; username?: string };
 events?: readonly string[];
 name?: string;
 scopeType?: string;
 sslVerificationRequired?: boolean;
 statistics?: Record<string, unknown>;
 url?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/webhooks/{webhookId}/latest": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; webhookId: string };
 query?: { event?: string; outcome?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 duration?: number;
 event?: string;
 eventScope?: { id?: string; type?: string };
 finish?: number;
 id?: number;
 request?: Record<string, unknown>;
 result?: Record<string, unknown>;
 start?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/webhooks/{webhookId}/statistics": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; webhookId: string };
 query?: { event?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/webhooks/{webhookId}/statistics/summary": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; webhookId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/projects/{projectKey}/webhooks/test": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: {
 sslVerificationRequired?: boolean;
 url?: string;
 webhookId?: number;
 };
 };
 requestBody?: {
 content: {
 "application/json": { password?: string; username?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/repos": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 archived?: string;
 limit?: number;
 name?: string;
 permission?: "REPO_ADMIN"
 | "REPO_READ"
 | "REPO_WRITE";
 projectkey?: string;
 projectname?: string;
 start?: number;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 visibility?: "public"
 | "private";
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 origin?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 partition?: number;
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 public?: boolean;
 relatedLinks?: Record<(...), (...)>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/secret-scanning/exempt": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 limit?: number;
 order?: "NAME_ASC"
 | "NAME_DESC";
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 origin?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 partition?: number;
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 public?: boolean;
 relatedLinks?: Record<(...), (...)>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: { "*/*": readonly { projectKey?: string; slug?: string }[] };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/secret-scanning/rules": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 filter?: string;
 limit?: number;
 order?: "NAME_ASC"
 | "NAME_DESC";
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: { resourceId?: ...; type?: ... };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody: {
 content: {
 "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/secret-scanning/rules/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 lineRegex?: string;
 name?: string;
 pathRegex?: string;
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/signing/x509-certificates": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": { fingerprint?: string; id?: number };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody: {
 content: { "multipart/form-data": { certificate?: string } };
 };
 responses: {
 "201": {
 content: {
 "application/json": { fingerprint?: string; id?: number };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/signing/x509-certificates/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content: {
 "application/json": { fingerprint?: string; id?: number };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/signing/x509-certificates/crl/{id}": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/system-signing/configuration": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": { enabled?: boolean } };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": { enabled?: boolean } } };
 responses: {
 "200": {
 content: { "application/json": { enabled?: boolean } };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/users": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 filter?: string;
 group?: string;
 permission?: string;
 "permission.N"?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 displayName?: string;
 email?: string;
 name?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/api/latest/users/{userSlug}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/users/{userSlug}/avatar.png": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": { href?: string; name?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: { "X-Atlassian-Token"?: string };
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: { content: { "multipart/form-data": { avatar?: string } } };
 responses: {
 "201": {
 content?: undefined;
 headers: { Location?: string; readonly [name: string]: unknown };
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/users/{userSlug}/settings": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 "boolean key"?: boolean;
 "long key"?: number;
 "string key"?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 "boolean key"?: boolean;
 "long key"?: number;
 "string key"?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/api/latest/users/credentials": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 oldPassword?: string;
 password?: string;
 passwordConfirm?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/audit/latest/notification-settings/retention-config-review": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/branch-permissions/latest/projects/{projectKey}/repos/{repositorySlug}/restrictions": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 limit?: number;
 matcherId?: string;
 matcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN";
 start?: number;
 type?:
 | "fast-forward-only"
 | "no-deletes"
 | "pull-request-only"
 | "read-only";
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 accessKeys?: readonly (...)[];
 groups?: readonly (...)[];
 id?: number;
 matcher?: { displayId?: ...; id?: ...; type?: ... };
 scope?: { resourceId?: ...; type?: ... };
 type?: string;
 users?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/vnd.atl.bitbucket.bulk+json": readonly {
 accessKeyIds?: readonly number[];
 accessKeys?: readonly {
 key?: (...)
 | (...);
 permission?:
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 project?: (...) | (...);
 repository?: (...) | (...);
 }[];
 groupNames?: readonly string[];
 groups?: readonly string[];
 id?: number;
 matcher?: {
 displayId?: string;
 id?: string;
 type?: { id?: ...; name?: ... };
 };
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 type?: string;
 users?: readonly {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 }[];
 userSlugs?: readonly string[];
 }[];
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 accessKeys?: readonly {
 key?: {
 algorithmType?: ...;
 bitLength?: ...;
 createdDate?: ...;
 expiryDays?: ...;
 fingerprint?: ...;
 id?: ...;
 label?: ...;
 lastAuthenticated?: ...;
 text?: ...;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 repository?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 origin?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 }[];
 groups?: readonly string[];
 id?: number;
 matcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 type?: string;
 users?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/branch-permissions/latest/projects/{projectKey}/repos/{repositorySlug}/restrictions/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 accessKeys?: readonly {
 key?: {
 algorithmType?: ...;
 bitLength?: ...;
 createdDate?: ...;
 expiryDays?: ...;
 fingerprint?: ...;
 id?: ...;
 label?: ...;
 lastAuthenticated?: ...;
 text?: ...;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 repository?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 origin?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 }[];
 groups?: readonly string[];
 id?: number;
 matcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 type?: string;
 users?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/branch-permissions/latest/projects/{projectKey}/restrictions": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: {
 limit?: number;
 matcherId?: string;
 matcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN";
 start?: number;
 type?:
 | "fast-forward-only"
 | "no-deletes"
 | "pull-request-only"
 | "read-only";
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 accessKeys?: readonly (...)[];
 groups?: readonly (...)[];
 id?: number;
 matcher?: { displayId?: ...; id?: ...; type?: ... };
 scope?: { resourceId?: ...; type?: ... };
 type?: string;
 users?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/vnd.atl.bitbucket.bulk+json": readonly {
 accessKeyIds?: readonly number[];
 accessKeys?: readonly {
 key?: (...)
 | (...);
 permission?:
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 project?: (...) | (...);
 repository?: (...) | (...);
 }[];
 groupNames?: readonly string[];
 groups?: readonly string[];
 id?: number;
 matcher?: {
 displayId?: string;
 id?: string;
 type?: { id?: ...; name?: ... };
 };
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 type?: string;
 users?: readonly {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 }[];
 userSlugs?: readonly string[];
 }[];
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 accessKeys?: readonly {
 key?: {
 algorithmType?: ...;
 bitLength?: ...;
 createdDate?: ...;
 expiryDays?: ...;
 fingerprint?: ...;
 id?: ...;
 label?: ...;
 lastAuthenticated?: ...;
 text?: ...;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 repository?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 origin?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 }[];
 groups?: readonly string[];
 id?: number;
 matcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 type?: string;
 users?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/branch-permissions/latest/projects/{projectKey}/restrictions/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 accessKeys?: readonly {
 key?: {
 algorithmType?: ...;
 bitLength?: ...;
 createdDate?: ...;
 expiryDays?: ...;
 fingerprint?: ...;
 id?: ...;
 label?: ...;
 lastAuthenticated?: ...;
 text?: ...;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 repository?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 origin?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 }[];
 groups?: readonly string[];
 id?: number;
 matcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 type?: string;
 users?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/branch-utils/latest/projects/{projectKey}/repos/{repositorySlug}/branches": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 dryRun?: boolean;
 endPoint?: string;
 name?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "application/json": { name?: string; startPoint?: string };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 default?: boolean;
 displayId?: string;
 id?: string;
 latestChangeset?: string;
 latestCommit?: string;
 type?: unknown;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/branch-utils/latest/projects/{projectKey}/repos/{repositorySlug}/branches/info/{commitId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 displayId?: string;
 id?: string;
 type?: "BRANCH"
 | "TAG";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "500": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/build-status/latest/commits/{commitId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string };
 query?: { limit?: number; orderBy?: string; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 buildNumber?: string;
 createdDate?: number;
 description?: string;
 duration?: number;
 key?: string;
 name?: string;
 parent?: string;
 ref?: string;
 state?: | "FAILED"
 | "INPROGRESS"
 | "SUCCESSFUL"
 | "UNKNOWN"
 | "CANCELLED";
 testResults?: { failed?: ...; skipped?: ...; successful?: ... };
 updatedDate?: number;
 url?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 buildNumber?: string;
 createdDate?: number;
 description?: string;
 duration?: number;
 key?: string;
 name?: string;
 parent?: string;
 ref?: string;
 state?: | "FAILED"
 | "INPROGRESS"
 | "SUCCESSFUL"
 | "UNKNOWN"
 | "CANCELLED";
 testResults?: {
 failed?: number;
 skipped?: number;
 successful?: number;
 };
 updatedDate?: number;
 url?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/build-status/latest/commits/stats": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": readonly string[] } };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/build-status/latest/commits/stats/{commitId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string };
 query?: { includeUnique?: boolean };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 cancelled?: number;
 failed?: number;
 inProgress?: number;
 successful?: number;
 unknown?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/comment-likes/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}/reactions/{emoticon}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 commitId: string;
 emoticon: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 commitId: string;
 emoticon: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 comment?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly {
 anchor?: ...;
 anchored?: ...;
 author?: ...;
 comments?: ...;
 createdDate?: ...;
 html?: ...;
 id?: ...;
 parent?: ...;
 pending?: ...;
 properties?: ...;
 reply?: ...;
 resolvedDate?: ...;
 resolver?: ...;
 severity?: ...;
 state?: ...;
 text?: ...;
 threadResolved?: ...;
 threadResolvedDate?: ...;
 threadResolver?: ...;
 updatedDate?: ...;
 version?: ...;
 }[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: (...)
 | (...);
 anchored?: (...) | (...) | (...);
 author?: (...) | (...);
 comments?: (...) | (...);
 createdDate?: (...) | (...);
 html?: (...) | (...);
 id?: (...) | (...);
 pending?: (...) | (...) | (...);
 properties?: (...) | (...);
 reply?: (...) | (...) | (...);
 resolvedDate?: (...) | (...);
 resolver?: (...) | (...);
 severity?: (...) | (...);
 state?: (...) | (...);
 text?: (...) | (...);
 threadResolved?: (...) | (...) | (...);
 threadResolvedDate?: (...) | (...);
 threadResolver?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 emoticon?: { shortcut?: string; url?: string; value?: string };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/comment-likes/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/reactions/{emoticon}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 emoticon: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commentId: string;
 emoticon: string;
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 comment?: {
 anchor?: {
 diffType?: (...)
 | (...)
 | (...)
 | (...);
 fileType?: (...) | (...) | (...);
 fromHash?: (...) | (...);
 line?: (...) | (...);
 lineType?: (...) | (...) | (...) | (...);
 multilineMarker?: (...) | (...);
 path?: (...) | (...);
 pullRequest?: (...) | (...);
 srcPath?: (...) | (...);
 toHash?: (...) | (...);
 };
 anchored?: boolean;
 author?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 comments?: readonly {
 anchor?: ...;
 anchored?: ...;
 author?: ...;
 comments?: ...;
 createdDate?: ...;
 html?: ...;
 id?: ...;
 parent?: ...;
 pending?: ...;
 properties?: ...;
 reply?: ...;
 resolvedDate?: ...;
 resolver?: ...;
 severity?: ...;
 state?: ...;
 text?: ...;
 threadResolved?: ...;
 threadResolvedDate?: ...;
 threadResolver?: ...;
 updatedDate?: ...;
 version?: ...;
 }[];
 createdDate?: number;
 html?: string;
 id?: number;
 parent?: {
 anchor?: (...)
 | (...);
 anchored?: (...) | (...) | (...);
 author?: (...) | (...);
 comments?: (...) | (...);
 createdDate?: (...) | (...);
 html?: (...) | (...);
 id?: (...) | (...);
 pending?: (...) | (...) | (...);
 properties?: (...) | (...);
 reply?: (...) | (...) | (...);
 resolvedDate?: (...) | (...);
 resolver?: (...) | (...);
 severity?: (...) | (...);
 state?: (...) | (...);
 text?: (...) | (...);
 threadResolved?: (...) | (...) | (...);
 threadResolvedDate?: (...) | (...);
 threadResolver?: (...) | (...);
 updatedDate?: (...) | (...);
 version?: (...) | (...);
 };
 pending?: boolean;
 properties?: Record<string, unknown>;
 reply?: boolean;
 resolvedDate?: number;
 resolver?: {
 active?: (...) | (...) | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 severity?: string;
 state?: string;
 text?: string;
 threadResolved?: boolean;
 threadResolvedDate?: number;
 threadResolver?: {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 updatedDate?: number;
 version?: number;
 };
 emoticon?: { shortcut?: string; url?: string; value?: string };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/default-reviewers/latest/projects/{projectKey}/condition": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 sourceMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 targetMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 sourceRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 targetRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/default-reviewers/latest/projects/{projectKey}/condition/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 sourceMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 targetMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 sourceRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 targetRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/default-reviewers/latest/projects/{projectKey}/conditions": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": readonly {
 id?: number;
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 }[];
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 sourceRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: { id?: ...; name?: ... };
 };
 targetRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: { id?: ...; name?: ... };
 };
 }[];
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 sourceMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 targetMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 sourceRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 targetRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: number; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 sourceMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 targetMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 sourceRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 targetRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/conditions": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": readonly {
 id?: number;
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 }[];
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 sourceRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: { id?: ...; name?: ... };
 };
 targetRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: { id?: ...; name?: ... };
 };
 }[];
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/reviewers": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 sourceRefId?: string;
 sourceRepoId?: string;
 targetRefId?: string;
 targetRepoId?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": readonly {
 id?: number;
 requiredApprovals?: number;
 reviewers?: readonly {
 active?: (...)
 | (...)
 | (...);
 avatarUrl?: (...) | (...);
 displayName?: (...) | (...);
 emailAddress?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 slug?: (...) | (...);
 type?: (...) | (...) | (...);
 }[];
 scope?: {
 resourceId?: number;
 type?: "GLOBAL"
 | "PROJECT"
 | "REPOSITORY";
 };
 sourceRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: { id?: ...; name?: ... };
 };
 targetRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: { id?: ...; name?: ... };
 };
 }[];
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/default-tasks/latest/projects/{projectKey}/repos/{repositorySlug}/tasks": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; markup?: string; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 description?: string;
 html?: string;
 id?: number;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "application/json": {
 description?: string;
 sourceMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: | "BRANCH"
 | "ANY_REF"
 | "MODEL_BRANCH"
 | "MODEL_CATEGORY"
 | "PATTERN";
 name?: string;
 };
 };
 targetMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: | "BRANCH"
 | "ANY_REF"
 | "MODEL_BRANCH"
 | "MODEL_CATEGORY"
 | "PATTERN";
 name?: string;
 };
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 description?: string;
 html?: string;
 id?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/default-tasks/latest/projects/{projectKey}/repos/{repositorySlug}/tasks/{taskId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; taskId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; taskId: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "application/json": {
 description?: string;
 sourceMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: | "BRANCH"
 | "ANY_REF"
 | "MODEL_BRANCH"
 | "MODEL_CATEGORY"
 | "PATTERN";
 name?: string;
 };
 };
 targetMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: | "BRANCH"
 | "ANY_REF"
 | "MODEL_BRANCH"
 | "MODEL_CATEGORY"
 | "PATTERN";
 name?: string;
 };
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 description?: string;
 html?: string;
 id?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/default-tasks/latest/projects/{projectKey}/tasks": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { limit?: number; markup?: string; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 description?: string;
 html?: string;
 id?: number;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "application/json": {
 description?: string;
 sourceMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: | "BRANCH"
 | "ANY_REF"
 | "MODEL_BRANCH"
 | "MODEL_CATEGORY"
 | "PATTERN";
 name?: string;
 };
 };
 targetMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: | "BRANCH"
 | "ANY_REF"
 | "MODEL_BRANCH"
 | "MODEL_CATEGORY"
 | "PATTERN";
 name?: string;
 };
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 description?: string;
 html?: string;
 id?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/default-tasks/latest/projects/{projectKey}/tasks/{taskId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; taskId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; taskId: string };
 query?: undefined;
 };
 requestBody: {
 content: {
 "application/json": {
 description?: string;
 sourceMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: | "BRANCH"
 | "ANY_REF"
 | "MODEL_BRANCH"
 | "MODEL_CATEGORY"
 | "PATTERN";
 name?: string;
 };
 };
 targetMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: | "BRANCH"
 | "ANY_REF"
 | "MODEL_BRANCH"
 | "MODEL_CATEGORY"
 | "PATTERN";
 name?: string;
 };
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 description?: string;
 html?: string;
 id?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/git/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/rebase": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 vetoes?: readonly {
 detailedMessage?: string;
 summaryMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: { content: { "application/json": { version?: number } } };
 responses: {
 "200": {
 content: {
 "application/json": {
 refChange?: {
 fromHash?: string;
 ref?: {
 displayId?: (...) | (...);
 id?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 refId?: string;
 toHash?: string;
 type?: "DELETE"
 | "ADD"
 | "UPDATE";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/git/latest/projects/{projectKey}/repos/{repositorySlug}/tags": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 force?: boolean;
 message?: string;
 name?: string;
 startPoint?: string;
 type?: "ANNOTATED"
 | "LIGHTWEIGHT";
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 displayId?: string;
 hash?: string;
 id?: string;
 latestChangeset?: string;
 latestCommit?: string;
 type?: "BRANCH"
 | "TAG";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/git/latest/projects/{projectKey}/repos/{repositorySlug}/tags/{name}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { name: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/gpg/latest/keys": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { user?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { limit?: number; start?: number; user?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 emailAddress?: string;
 expiryDate?: number;
 fingerprint?: string;
 id?: string;
 subKeys?: readonly (...)[];
 text?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { user?: string };
 };
 requestBody?: {
 content: {
 "application/json": {
 emailAddress?: string;
 expiryDate?: number;
 fingerprint?: string;
 id?: string;
 subKeys?: readonly { expiryDate?: string; fingerprint?: string }[];
 text?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 emailAddress?: string;
 expiryDate?: number;
 fingerprint?: string;
 id?: string;
 subKeys?: readonly { expiryDate?: string; fingerprint?: string }[];
 text?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/gpg/latest/keys/{fingerprintOrId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { fingerprintOrId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/annotations": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: {
 externalId?: string;
 key?: string;
 path?: string;
 severity?: string;
 type?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 annotations?: readonly {
 externalId?: string;
 line?: number;
 link?: string;
 message?: string;
 path?: string;
 reportKey?: string;
 severity?: string;
 type?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commitId: string; projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 createdDate?: number;
 data?: readonly (...)[];
 details?: string;
 key?: string;
 link?: string;
 logoUrl?: string;
 reporter?: string;
 result?: "FAIL" | "PASS";
 title?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commitId: string;
 key: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commitId: string;
 key: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: number;
 data?: readonly {
 title?: string;
 type?: string;
 value?: Record<(...), (...)>;
 }[];
 details?: string;
 key?: string;
 link?: string;
 logoUrl?: string;
 reporter?: string;
 result?: "FAIL"
 | "PASS";
 title?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commitId: string;
 key: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 coverageProviderKey?: string;
 createdDate?: number;
 data: readonly {
 title?: string;
 type?: string;
 value?: Record<string, unknown>;
 }[];
 details?: string;
 link?: string;
 logoUrl?: string;
 reporter?: string;
 result?: string;
 title: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: number;
 data?: readonly {
 title?: string;
 type?: string;
 value?: Record<(...), (...)>;
 }[];
 details?: string;
 key?: string;
 link?: string;
 logoUrl?: string;
 reporter?: string;
 result?: "FAIL"
 | "PASS";
 title?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}/annotations": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commitId: string;
 key: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: { externalId?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commitId: string;
 key: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 annotations?: readonly {
 externalId?: string;
 line?: number;
 link?: string;
 message?: string;
 path?: string;
 reportKey?: string;
 severity?: string;
 type?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commitId: string;
 key: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 annotations?: readonly {
 externalId?: string;
 line?: number;
 link?: string;
 message: string;
 path?: string;
 severity: string;
 type?: string;
 }[];
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}/annotations/{externalId}": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 commitId: string;
 externalId: string;
 key: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 externalId?: string;
 line?: number;
 link?: string;
 message: string;
 path?: string;
 severity: string;
 type?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/jira/latest/comments/{commentId}/issues": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { commentId: string };
 query?: { applicationId?: string };
 };
 requestBody?: { content: { "application/json": string } };
 responses: {
 "200": {
 content: {
 "application/json": { commentId?: number; issueKey?: string };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/jira/latest/issues/{issueKey}/commits": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { issueKey: string };
 query?: { limit?: number; maxChanges?: string; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 changes?: {
 isLastPage?: ...;
 limit?: ...;
 nextPageStart?: ...;
 size?: ...;
 start?: ...;
 values?: ...;
 };
 fromCommit?: { displayId?: ...; id?: ... };
 links?: Record<(...), (...)>;
 repository?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 origin?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 toCommit?: {
 author?: ...;
 authorTimestamp?: ...;
 committer?: ...;
 committerTimestamp?: ...;
 displayId?: ...;
 id?: ...;
 message?: ...;
 parents?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/jira/latest/projects/{projectKey}/primary-enhanced-entitylink": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 applicationLinkId?: string;
 displayUrl?: string;
 projectId?: number;
 projectKey?: string;
 projectName?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/jira/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/issues": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 projectKey: string;
 pullRequestId: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json;charset=UTF-8": readonly {
 key?: string;
 url?: string;
 }[];
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: {
 effective?: string;
 filter?: string;
 limit?: number;
 minimumPermission?: string;
 permission?: string;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 key?: {
 algorithmType?: ...;
 bitLength?: ...;
 createdDate?: ...;
 expiryDays?: ...;
 fingerprint?: ...;
 id?: ...;
 label?: ...;
 lastAuthenticated?: ...;
 text?: ...;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 repository?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 origin?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 key?: {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 repository?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 key?: {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 repository?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh/{keyId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { keyId: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { keyId: string; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 key?: {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 repository?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh/{keyId}/permission/{permission}": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: {
 keyId: string;
 permission: string;
 projectKey: string;
 repositorySlug: string;
 };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 key?: {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 repository?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/keys/latest/projects/{projectKey}/ssh": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: {
 filter?: string;
 limit?: number;
 permission?: string;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 key?: {
 algorithmType?: ...;
 bitLength?: ...;
 createdDate?: ...;
 expiryDays?: ...;
 fingerprint?: ...;
 id?: ...;
 label?: ...;
 lastAuthenticated?: ...;
 text?: ...;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 repository?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 origin?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 key?: {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 repository?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 key?: {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 repository?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/keys/latest/projects/{projectKey}/ssh/{keyId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { keyId: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { keyId: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 key?: {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 repository?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/keys/latest/projects/{projectKey}/ssh/{keyId}/permission/{permission}": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { keyId: string; permission: string; projectKey: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 key?: {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 permission?: | "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_ADMIN"
 | "PROJECT_CREATE"
 | "PROJECT_READ"
 | "PROJECT_VIEW"
 | "PROJECT_WRITE"
 | "REPO_ADMIN"
 | "REPO_CREATE"
 | "REPO_READ"
 | "REPO_WRITE"
 | "SYS_ADMIN"
 | "USER_ADMIN";
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 repository?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/keys/latest/ssh/{keyId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { keyId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 projects?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key?: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 repositories?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: (...) | (...) | (...);
 defaultBranch?: (...) | (...);
 description?: (...) | (...);
 forkable?: (...) | (...) | (...);
 hierarchyId?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 partition?: (...) | (...);
 project?: (...) | (...);
 public?: (...) | (...) | (...);
 relatedLinks?: (...) | (...);
 scmId?: (...) | (...);
 scope?: (...) | (...);
 slug?: (...) | (...);
 state?: (...) | (...) | (...) | (...) | (...);
 statusMessage?: (...) | (...);
 };
 partition?: number;
 project?: {
 avatar?: (...)
 | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/keys/latest/ssh/{keyId}/projects": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { keyId: number };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/keys/latest/ssh/{keyId}/repos": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { keyId: string };
 query?: { withRestrictions?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/account/settings/preferred-mirror": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 baseUrl?: string;
 enabled?: boolean;
 id?: string;
 lastSeenDate?: string;
 mirrorType?: "FARM"
 | "SINGLE";
 name?: string;
 productVersion?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": string } };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/analyticsSettings": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 canCollectAnalytics?: boolean;
 serverTime?: number;
 supportEntitlementNumber?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/authenticate": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 credentials: | { token: string }
 | { algorithm?: string; publicKey: string; username?: string }
 | { password: string; username: string };
 repositoryId?: number;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 effectivePermissions?: Record<string, unknown>;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/farmNodes": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json;charset=UTF-8": readonly {
 address?: { address?: string; port?: number };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 }[];
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json;charset=UTF-8": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/mirrorRepos/{externalRepositoryId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { externalRepositoryId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 available?: boolean;
 cloneUrls?: readonly { href?: string; name?: string }[];
 lastUpdated?: string;
 mirrorName?: string;
 pushUrls?: readonly { href?: string; name?: string }[];
 repositoryId?: string;
 status?:
 | "AVAILABLE"
 | "ERROR_AVAILABLE"
 | "ERROR_INITIALIZING"
 | "INITIALIZING"
 | "NOT_MIRRORED";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/mirrorServers": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 baseUrl?: string;
 enabled?: boolean;
 id?: string;
 lastSeenDate?: string;
 mirrorType?: "FARM"
 | "SINGLE";
 name?: string;
 productVersion?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/mirrorServers/{mirrorId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { mirrorId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { mirrorId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 baseUrl?: string;
 enabled?: boolean;
 id?: string;
 lastSeenDate?: string;
 mirrorType?: "FARM"
 | "SINGLE";
 name?: string;
 productVersion?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { mirrorId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { baseUrl?: string; productVersion?: string };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 baseUrl?: string;
 enabled?: boolean;
 id?: string;
 lastSeenDate?: string;
 mirrorType?: "FARM"
 | "SINGLE";
 name?: string;
 productVersion?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/mirroring/latest/mirrorServers/{mirrorId}/events": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { mirrorId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 mirrorRepoId?: number;
 type?: "SYNCHRONIZATION_FAILED"
 | "SYNCHRONIZED";
 upstreamRepoId?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/progress": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 discovering?: boolean;
 syncedRepos?: number;
 totalRepos?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/projects/{projectId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key?: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/projects/{projectId}/repos": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectId: string };
 query?: {
 includeDefaultBranch?: "true" | "false";
 limit?: number;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 origin?: {
 archived?: ...;
 defaultBranch?: ...;
 description?: ...;
 forkable?: ...;
 hierarchyId?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 partition?: ...;
 project?: ...;
 public?: ...;
 relatedLinks?: ...;
 scmId?: ...;
 scope?: ...;
 slug?: ...;
 state?: ...;
 statusMessage?: ...;
 };
 partition?: number;
 project?: {
 avatar?: ...;
 avatarUrl?: ...;
 description?: ...;
 id?: ...;
 key: ...;
 links?: ...;
 name?: ...;
 public?: ...;
 scope?: ...;
 type?: ...;
 };
 properties?: {
 contentHash?: ...;
 defaultBranchId?: ...;
 metadataHash?: ...;
 };
 public?: boolean;
 relatedLinks?: Record<(...), (...)>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/repos": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { includeDefaultBranch?: "true"
 | "false" };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 properties?: {
 contentHash?: string;
 defaultBranchId?: string;
 metadataHash?: string;
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/repos/{repoId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { repoId: string };
 query?: { includeDefaultBranch?: boolean };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 origin?: {
 archived?: boolean;
 defaultBranch?: string;
 description?: string;
 forkable?: boolean;
 hierarchyId?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 partition?: number;
 project?: {
 avatar?: (...) | (...);
 avatarUrl?: (...) | (...);
 description?: (...) | (...);
 id?: (...) | (...);
 key: string;
 links?: (...) | (...);
 name?: (...) | (...);
 public?: (...) | (...) | (...);
 scope?: (...) | (...);
 type?: (...) | (...) | (...);
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 partition?: number;
 project?: {
 avatar?: string;
 avatarUrl?: string;
 description?: string;
 id?: number;
 key: string;
 links?: Record<string, unknown>;
 name?: string;
 public?: boolean;
 scope?: string;
 type?: "NORMAL" | "PERSONAL";
 };
 properties?: {
 contentHash?: string;
 defaultBranchId?: string;
 metadataHash?: string;
 };
 public?: boolean;
 relatedLinks?: Record<string, unknown>;
 scmId?: string;
 scope?: string;
 slug?: string;
 state?:
 | "AVAILABLE"
 | "INITIALISATION_FAILED"
 | "INITIALISING"
 | "OFFLINE";
 statusMessage?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/repos/{repoId}/mirrors": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { repoId: string };
 query?: { preAuthorized?: boolean };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 links?: Record<string, unknown>;
 mirrorServer?: {
 baseUrl?: string;
 enabled?: boolean;
 id?: string;
 lastSeenDate: string;
 mirrorType?: "FARM" | "SINGLE";
 name?: string;
 productVersion?: string;
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/requests": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 limit?: number;
 start?: number;
 state?: "ACCEPTED"
 | "PENDING"
 | "REJECTED";
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 id?: number;
 mirrorBaseUrl?: string;
 mirrorId?: string;
 mirrorName?: string;
 mirrorType?: "FARM"
 | "SINGLE";
 productVersion?: string;
 state?: "ACCEPTED" | "PENDING" | "REJECTED";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 id?: number;
 mirrorBaseUrl?: string;
 mirrorId?: string;
 mirrorName?: string;
 mirrorType?: "FARM"
 | "SINGLE";
 productVersion?: string;
 state?: "ACCEPTED" | "PENDING" | "REJECTED";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 mirrorBaseUrl?: string;
 mirrorId?: string;
 mirrorName?: string;
 mirrorType?: "FARM"
 | "SINGLE";
 productVersion?: string;
 state?: "ACCEPTED" | "PENDING" | "REJECTED";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/requests/{mirroringRequestId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { mirroringRequestId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { mirroringRequestId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: number;
 mirrorBaseUrl?: string;
 mirrorId?: string;
 mirrorName?: string;
 mirrorType?: "FARM"
 | "SINGLE";
 productVersion?: string;
 state?: "ACCEPTED" | "PENDING" | "REJECTED";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/requests/{mirroringRequestId}/accept": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { mirroringRequestId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 baseUrl?: string;
 enabled?: boolean;
 id?: string;
 lastSeenDate?: string;
 mirrorType?: "FARM"
 | "SINGLE";
 name?: string;
 productVersion?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/requests/{mirroringRequestId}/reject": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { mirroringRequestId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 baseUrl?: string;
 enabled?: boolean;
 id?: string;
 lastSeenDate?: string;
 mirrorType?: "FARM"
 | "SINGLE";
 name?: string;
 productVersion?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/supportInfo/out-of-sync-repos/content": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json;charset=UTF-8": string };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json;charset=UTF-8": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json;charset=UTF-8": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repo-lock-owner": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 externalRepositoryId?: string;
 lockAcquireTime?: string;
 nodeId?: string;
 requestId?: string;
 threadName?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repoSyncStatus": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 externalRepoId?: string;
 failedSyncCount?: number;
 hashes?: { content?: string; metadata?: string };
 initialSyncDate?: string;
 lastSyncDate?: string;
 localProjectId?: number;
 localRepoId?: number;
 upstreamId?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/supportInfo/refChangesQueue": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json;charset=UTF-8": {
 values?: readonly {
 attempt?: number;
 createdAt?: string;
 externalRepoId?: string;
 type?: "incremental"
 | "snapshot";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/supportInfo/refChangesQueue/count": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/supportInfo/repo-lock-owners": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json;charset=UTF-8": readonly {
 externalRepositoryId?: string;
 lockAcquireTime?: string;
 nodeId?: string;
 requestId?: string;
 threadName?: string;
 }[];
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/supportInfo/repoSyncStatus": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 externalRepoId?: string;
 failedSyncCount?: number;
 hashes?: { content?: ...; metadata?: ... };
 initialSyncDate?: string;
 lastSyncDate?: string;
 localProjectId?: number;
 localRepoId?: number;
 upstreamId?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/syncSettings": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 mode?: "ALL_PROJECTS"
 | "SELECTED_PROJECTS";
 projectIds?: readonly string[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 mode?: "ALL_PROJECTS"
 | "SELECTED_PROJECTS";
 projectIds?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 mode?: "ALL_PROJECTS"
 | "SELECTED_PROJECTS";
 projectIds?: readonly string[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/mirroring/latest/syncSettings/mode": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": string } };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/mirroring/latest/syncSettings/projects": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": readonly string[] } };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/syncSettings/projects/{projectId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/upstreamServer": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 baseUrl?: string;
 id?: string;
 state?: | "PENDING"
 | "UNKNOWN"
 | "REMOVED"
 | "INITIALIZING"
 | "INSTALLED";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/zdu/end": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 rollingUpgradeEnabled?: boolean;
 version?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/mirroring/latest/zdu/start": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 rollingUpgradeEnabled?: boolean;
 version?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/policies/latest/admin/repos/archive": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 permission?: | "ADMIN"
 | "PROJECT_ADMIN"
 | "REPO_ADMIN"
 | "SYS_ADMIN";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 permission?: "ADMIN"
 | "PROJECT_ADMIN"
 | "REPO_ADMIN"
 | "SYS_ADMIN";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 permission?: | "ADMIN"
 | "PROJECT_ADMIN"
 | "REPO_ADMIN"
 | "SYS_ADMIN";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/policies/latest/admin/repos/delete": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 permission?: | "ADMIN"
 | "PROJECT_ADMIN"
 | "REPO_ADMIN"
 | "SYS_ADMIN";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 permission?: "ADMIN"
 | "PROJECT_ADMIN"
 | "REPO_ADMIN"
 | "SYS_ADMIN";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 permission?: | "ADMIN"
 | "PROJECT_ADMIN"
 | "REPO_ADMIN"
 | "SYS_ADMIN";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/condition": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "*/*": {
 buildParentKeys: readonly string[];
 exemptRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 refMatcher: {
 displayId?: string;
 id?: string;
 type?: {
 id?: | "BRANCH"
 | "ANY_REF"
 | "MODEL_BRANCH"
 | "MODEL_CATEGORY"
 | "PATTERN";
 name?: string;
 };
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 buildParentKeys?: readonly string[];
 exemptRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 id?: number;
 refMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/condition/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: number; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: number; projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "*/*": {
 buildParentKeys: readonly string[];
 exemptRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 refMatcher: {
 displayId?: string;
 id?: string;
 type?: {
 id?: | "BRANCH"
 | "ANY_REF"
 | "MODEL_BRANCH"
 | "MODEL_CATEGORY"
 | "PATTERN";
 name?: string;
 };
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 buildParentKeys?: readonly string[];
 exemptRefMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 id?: number;
 refMatcher?: {
 displayId?: string;
 id?: string;
 type?: {
 id?: (...)
 | (...)
 | (...)
 | (...)
 | (...)
 | (...);
 name?: (...) | (...);
 };
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
 };
 "/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/conditions": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 buildParentKeys?: readonly (...)[];
 exemptRefMatcher?: { displayId?: ...; id?: ...; type?: ... };
 id?: number;
 refMatcher?: { displayId?: ...; id?: ...; type?: ... };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/ssh/latest/keys": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { user?: string; userName?: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 limit?: number;
 start?: number;
 user?: string;
 userName?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { user?: string };
 };
 requestBody?: {
 content: {
 "application/json": {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 };
 };
 responses: {
 "201": {
 content: {
 "application/json": {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/ssh/latest/keys/{keyId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { keyId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { keyId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 algorithmType?: string;
 bitLength?: number;
 createdDate?: string;
 expiryDays?: number;
 fingerprint?: string;
 id?: number;
 label?: string;
 lastAuthenticated?: string;
 text?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/ssh/latest/settings": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 accessKeysEnabled?: boolean;
 baseUrl?: string;
 enabled?: boolean;
 fingerprint?: { algorithm?: string; value?: string };
 port?: number;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
 };
 "/sync/latest/projects/{projectKey}/repos/{repositorySlug}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { at?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 aheadRefs?: {
 displayId?: string;
 id?: string;
 state?: "AHEAD"
 | "DIVERGED"
 | "ORPHANED";
 tag?: boolean;
 type?: "BRANCH" | "TAG";
 };
 available?: boolean;
 divergedRefs?: {
 displayId?: string;
 id?: string;
 state?: "AHEAD"
 | "DIVERGED"
 | "ORPHANED";
 tag?: boolean;
 type?: "BRANCH" | "TAG";
 };
 enabled?: boolean;
 lastSync?: number;
 orphanedRefs?: {
 displayId?: string;
 id?: string;
 state?: "AHEAD"
 | "DIVERGED"
 | "ORPHANED";
 tag?: boolean;
 type?: "BRANCH" | "TAG";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 aheadRefs?: {
 displayId?: string;
 id?: string;
 state?: "AHEAD"
 | "DIVERGED"
 | "ORPHANED";
 tag?: boolean;
 type?: "BRANCH" | "TAG";
 };
 available?: boolean;
 divergedRefs?: {
 displayId?: string;
 id?: string;
 state?: "AHEAD"
 | "DIVERGED"
 | "ORPHANED";
 tag?: boolean;
 type?: "BRANCH" | "TAG";
 };
 enabled?: boolean;
 lastSync?: number;
 orphanedRefs?: {
 displayId?: string;
 id?: string;
 state?: "AHEAD"
 | "DIVERGED"
 | "ORPHANED";
 tag?: boolean;
 type?: "BRANCH" | "TAG";
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 aheadRefs?: {
 displayId?: string;
 id?: string;
 state?: "AHEAD"
 | "DIVERGED"
 | "ORPHANED";
 tag?: boolean;
 type?: "BRANCH" | "TAG";
 };
 available?: boolean;
 divergedRefs?: {
 displayId?: string;
 id?: string;
 state?: "AHEAD"
 | "DIVERGED"
 | "ORPHANED";
 tag?: boolean;
 type?: "BRANCH" | "TAG";
 };
 enabled?: boolean;
 lastSync?: number;
 orphanedRefs?: {
 displayId?: string;
 id?: string;
 state?: "AHEAD"
 | "DIVERGED"
 | "ORPHANED";
 tag?: boolean;
 type?: "BRANCH" | "TAG";
 };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
 "/sync/latest/projects/{projectKey}/repos/{repositorySlug}/synchronize": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 action?: "DISCARD"
 | "MERGE"
 | "REBASE";
 context?: { commitMessage?: string };
 refId?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 displayId?: string;
 id?: string;
 state?: "AHEAD"
 | "DIVERGED"
 | "ORPHANED";
 tag?: boolean;
 type?: "BRANCH" | "TAG";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "501": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
 };
}

Index

Properties

Properties

`Readonly`/access-tokens/latest/projects/{projectKey}

"/access-tokens/latest/projects/{projectKey}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get project HTTP tokens

Description
Get all access tokens associated with the given project.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: { limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing a page of access tokens and associated details.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to get access tokens for this project or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Create project HTTP token

Description
Create an access token for the project according to the given request.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 }
 Description
 The request containing the details of the access token to create.
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the raw access token and associated details.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 One of the following error cases occurred (check the error message for more details).
 
 - The request does not contain a token name - The request does not contain a list of permissions, or the list of permissions is empty - One of the provided permission levels are unknown - The project already has the maximum number of tokens
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to create an access token for this project or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified project does not exist.
Optional Readonlytrace?: undefined

`Readonly`/access-tokens/latest/projects/{projectKey}/{tokenId}

"/access-tokens/latest/projects/{projectKey}/{tokenId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Delete a HTTP token

Description
Delete the access token identified by the given ID.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; tokenId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlytokenId: string
 Description
 The token id.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the token has been deleted.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to delete an access token on behalf of this user or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user or token does not exist.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get HTTP token by ID

Description
Get the access token identified by the given ID.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; tokenId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlytokenId: string
 Description
 The token id.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the access token and associated details.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to get access tokens on behalf of this user or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user or token does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update HTTP token

Description
Modify an access token according to the given request. Any fields not specified will not be altered.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; tokenId: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; tokenId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlytokenId: string
 Description
 The token id.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 }
 Description
 The request containing the details of the access token to modify
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the updated access token and associated details.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 One of the provided permission levels are unknown.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to update an access token on behalf of this user or authentication failed.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}

"/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get repository HTTP tokens

Description
Get all access tokens associated with the given repository.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: { limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing a page of access tokens and associated details.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to get access tokens for this repository or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Create repository HTTP token

Description
Create an access token for the repository according to the given request.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 }
 Description
 The request containing the details of the access token to create.
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the raw access token and associated details.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 One of the following error cases occurred (check the error message for more details).
 
 - The request does not contain a token name- The request does not contain a list of permissions, or the list of permissions is empty- One of the provided permission levels are unknown- The repository already has the maximum number of tokens
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to create an access token for this repository or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified repository does not exist.
Optional Readonlytrace?: undefined

`Readonly`/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}/{tokenId}

"/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}/{tokenId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Delete a HTTP token

Description
Delete the access token identified by the given ID.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; tokenId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlytokenId: string
 Description
 The token id.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the token has been deleted.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to delete an access token on behalf of this user or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user or token does not exist.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get HTTP token by ID

Description
Get the access token identified by the given ID.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; tokenId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlytokenId: string
 Description
 The token id.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the access token and associated details.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to get access tokens on behalf of this user or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user or token does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update HTTP token

Description
Modify an access token according to the given request. Any fields not specified will not be altered.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { projectKey: string; repositorySlug: string; tokenId: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; tokenId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlytokenId: string
 Description
 The token id.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 }
 Description
 The request containing the details of the access token to modify
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the updated access token and associated details.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 One of the provided permission levels are unknown.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to update an access token on behalf of this user or authentication failed.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/access-tokens/latest/users/{userSlug}

"/access-tokens/latest/users/{userSlug}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: { limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get personal HTTP tokens

Description
Get all access tokens associated with the given user.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: { limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { userSlug: string }
 - ReadonlyuserSlug: string
 Description
 The user slug.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { createdDate?: string; id?: string; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing a page of access tokens and associated details.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to get access tokens on behalf of this user or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Create personal HTTP token

Description
Create an access token for the user according to the given request.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { userSlug: string }
 - ReadonlyuserSlug: string
 Description
 The user slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 }
 Description
 The request containing the details of the access token to create.
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 token?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the raw access token and associated details.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 One of the following error cases occurred (check the error message for more details).
 
 - The request does not contain a token name - The request does not contain a list of permissions, or the list of permissions is empty - One of the provided permission levels are unknown - The user already has their maximum number of tokens
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to create an access token on behalf of this user or authentication failed
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user does not exist.
Optional Readonlytrace?: undefined

`Readonly`/access-tokens/latest/users/{userSlug}/{tokenId}

"/access-tokens/latest/users/{userSlug}/{tokenId}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Delete a HTTP token

Description
Delete the access token identified by the given ID.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { tokenId: string; userSlug: string }
 - ReadonlytokenId: string
 Description
 The token id.
 - ReadonlyuserSlug: string
 Description
 The user slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the token has been deleted.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to delete an access token on behalf of this user or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user or token does not exist.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get HTTP token by ID

Description
Get the access token identified by the given ID.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { tokenId: string; userSlug: string }
 - ReadonlytokenId: string
 Description
 The token id.
 - ReadonlyuserSlug: string
 Description
 The user slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the access token and associated details.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to get access tokens on behalf of this user or authentication failed.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user or token does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update HTTP token

Description
Modify an access token according to the given request. Any fields not specified will not be altered.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { tokenId: string; userSlug: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { tokenId: string; userSlug: string }
 - ReadonlytokenId: string
 Description
 The token id.
 - ReadonlyuserSlug: string
 Description
 The user slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 expiryDays?: number;
 name?: string;
 permissions?: readonly string[];
 };
 };
 }
 Description
 The request containing the details of the access token to modify
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 createdDate?: string;
 id?: string;
 name?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the updated access token and associated details.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 One of the provided permission levels are unknown.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not permitted to update an access token on behalf of this user or authentication failed.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/admin

"/admin": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 keyTypeRestrictions?: readonly {
 algorithm?: string;
 allowed?: boolean;
 minKeyLength?: { asInt?: ...; present?: ... };
 }[];
 maxExpiryDays?: { asInt?: number; present?: boolean };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 keyTypeRestrictions?: readonly {
 algorithm?: string;
 allowed?: boolean;
 minKeyLength?: { asInt?: ...; present?: ... };
 }[];
 maxExpiryDays?: { asInt?: number; present?: boolean };
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 keyTypeRestrictions?: readonly {
 algorithm?: string;
 allowed?: boolean;
 minKeyLength?: { asInt?: ...; present?: ... };
 }[];
 maxExpiryDays?: { asInt?: number; present?: boolean };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get global SSH key settings

Description
Gets the global settings that enforce the maximum expiry of SSH keys and restrictions on SSH key types.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 keyTypeRestrictions?: readonly {
 algorithm?: string;
 allowed?: boolean;
 minKeyLength?: { asInt?: ...; present?: ... };
 }[];
 maxExpiryDays?: { asInt?: number; present?: boolean };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 keyTypeRestrictions?: readonly {
 algorithm?: string;
 allowed?: boolean;
 minKeyLength?: { asInt?: ...; present?: ... };
 }[];
 maxExpiryDays?: { asInt?: number; present?: boolean };
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The global ssh key settings configuration.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to retrieve the ssh keys global settings configuration.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 keyTypeRestrictions?: readonly {
 algorithm?: string;
 allowed?: boolean;
 minKeyLength?: { asInt?: ...; present?: ... };
 }[];
 maxExpiryDays?: { asInt?: number; present?: boolean };
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update global SSH key settings

Description
Updates the global settings that enforces the maximum expiry of SSH keys and restrictions on SSH key types.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 keyTypeRestrictions?: readonly {
 algorithm?: string;
 allowed?: boolean;
 minKeyLength?: { asInt?: ...; present?: ... };
 }[];
 maxExpiryDays?: { asInt?: number; present?: boolean };
 };
 };
 }
 Description
 A request containing expiry length to be set for SSH keys and a list of SSH key type restrictions.
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The ssh key global settings were updated.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The request was invalid, which may be due to:
 
 - attempted to set expiry to less than 1 day - attempted to set expiry using partial days - attempted to set a restriction on a key type which was invalid The exact reason for the error will be provided in the error message.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to update these settings.
Optional Readonlytrace?: undefined

`Readonly`/admin/supported-key-types

"/admin/supported-key-types": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get supported SSH key algorithms and lengths

Description
Retrieves a list of all supported SSH key algorithms and lengths.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A list of supported SSH key algorithms and lengths.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to retrieve this list.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/banner

"/api/latest/admin/banner": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 audience?: "ALL"
 | "AUTHENTICATED";
 enabled?: boolean;
 message?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 audience: "ALL"
 | "AUTHENTICATED";
 enabled?: boolean;
 message?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Delete announcement banner

Description
Deletes a banner, if one is present in the database.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The query executed successfully, whether a banner was deleted or not
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The user does not have permission to access the banner service through this endpoint
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 audience?: "ALL"
 | "AUTHENTICATED";
 enabled?: boolean;
 message?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": { content?: undefined; headers: Readonly<Record<string, unknown>> };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get announcement banner

Description
Gets the announcement banner, if one exists and is available to the user
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 audience?: "ALL" | "AUTHENTICATED";
 enabled?: boolean;
 message?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "204": { content?: undefined; headers: Readonly<Record<string, unknown>> };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 audience?: "ALL" | "AUTHENTICATED";
 enabled?: boolean;
 message?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The requested banner
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 There is no banner to display
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The user does not have permission to access the banner service through this endpoint
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 audience: "ALL"
 | "AUTHENTICATED";
 enabled?: boolean;
 message?: string;
 };
 };
 };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update/Set announcement banner

Description
Sets the announcement banner with the provided JSON. Only users authenticated as Admins may call this resource
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 audience: "ALL" | "AUTHENTICATED";
 enabled?: boolean;
 message?: string;
 };
 };
 }
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The banner was set successfully
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 There was malformed or incorrect data in the provided JSON
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The user does not have permission to access the banner service through this endpoint
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/cluster

"/api/latest/admin/cluster": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 localNode?: {
 address?: { address?: (...)
 | (...); port?: (...) | (...) };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 };
 nodes?: readonly {
 address?: { address?: ...; port?: ... };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 }[];
 running?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 localNode?: {
 address?: { address?: (...)
 | (...); port?: (...) | (...) };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 };
 nodes?: readonly {
 address?: { address?: ...; port?: ... };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 }[];
 running?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get cluster node information
Description
Gets information about the nodes that currently make up the stash cluster.
```
The authenticated user must have the SYS_ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 localNode?: {
 address?: { address?: (...) | (...); port?: (...) | (...) };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 };
 nodes?: readonly {
 address?: { address?: ...; port?: ... };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 }[];
 running?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 localNode?: {
 address?: { address?: (...) | (...); port?: (...) | (...) };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 };
 nodes?: readonly {
 address?: { address?: ...; port?: ... };
 buildVersion?: string;
 id?: string;
 local?: boolean;
 name?: string;
 }[];
 running?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing information about the cluster
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to retrieve the cluster information.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/default-branch

"/api/latest/admin/default-branch": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": { id?: string } } };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Clear default branch
Description
Clears the global default branch, which is used when creating new repositories if an explicit default branch is not specified, if one has been configured.
```
The authenticated user must have ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The default branch has been cleared.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The current user does not have sufficient permissions to clear the global default branch.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get the default branch
Description
Retrieves the configured global default branch, which is used when creating new repositories if an explicit default branch is not specified.
```
The user must be authenticated to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The configured global default branch.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 No global default branch has been configured.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": { id?: string } } };
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update/Set default branch
Description
Configures the global default branch, which is used when creating new repositories if an explicit default branch is not specified.
```
The authenticated user must have ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { id?: string } } }
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The default branch has been set.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The current user does not have sufficient permissions to configure the global default branch.
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/git/mesh/config/control-plane.pem

"/api/latest/admin/git/mesh/config/control-plane.pem": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "text/plain": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "text/plain": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get the control plane PEM
Description
Obtain the control plane PEM.
```
The authenticated user must have **SYS_ADMIN** permission.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: { "text/plain": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "text/plain": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The control plane PEM.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/git/mesh/diagnostics/connectivity

"/api/latest/admin/git/mesh/diagnostics/connectivity": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 reports?: readonly {
 node?: { id?: ...; name?: ...; type?: ... };
 summaries?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 reports?: readonly {
 node?: { id?: ...; name?: ...; type?: ... };
 summaries?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Generate Mesh connectivity report
Description
Generates a connectivity report between the Bitbucket node(s) and the Mesh node(s).
```
The authenticated user must have **SYS_ADMIN** permission.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 reports?: readonly {
 node?: { id?: ...; name?: ...; type?: ... };
 summaries?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 reports?: readonly {
 node?: { id?: ...; name?: ...; type?: ... };
 summaries?: readonly (...)[];
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The connectivity report between the Bitbucket node(s) and Mesh node(s).
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/git/mesh/nodes

"/api/latest/admin/git/mesh/nodes": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get all registered Mesh nodes
Description
Get all the registered Mesh nodes.
```
The authenticated user must have **SYS_ADMIN** permission.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE" | "OFFLINE" | "DELETING" | "DISABLED" | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE" | "OFFLINE" | "DELETING" | "DISABLED" | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The list of registered Mesh nodes.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Register new Mesh node
Description
Register a new Mesh node.
```
The authenticated user must have **SYS_ADMIN** permission.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE" | "OFFLINE" | "DELETING" | "DISABLED" | "DRAINING";
 };
 };
 }
 Description
 The request specifying the new Mesh node.
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE" | "OFFLINE" | "DELETING" | "DISABLED" | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE" | "OFFLINE" | "DELETING" | "DISABLED" | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The newly registered Mesh node.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The request was malformed.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/git/mesh/nodes/{id}

"/api/latest/admin/git/mesh/nodes/{id}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: number };
 query?: { force?: boolean };
 };
 requestBody?: undefined;
 responses: {
 default: {
 content: { "application/json;charset=UTF-8": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: number };
 query?: { force?: boolean };
 };
 requestBody?: undefined;
 responses: {
 default: {
 content: { "application/json;charset=UTF-8": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Delete Mesh node
Description
Delete a Mesh node
```
The authenticated user must have **SYS_ADMIN** permission.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: number };
 query?: { force?: boolean };
 }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 default: {
 content: { "application/json;charset=UTF-8": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonlydefault: {
 content: { "application/json;charset=UTF-8": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 default response
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get Mesh node
Description
Get the registered Mesh node that matches the supplied ID.
```
The authenticated user must have **SYS_ADMIN** permission.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string }
 - Readonlyid: string
 Description
 The ID of the Mesh node.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE" | "OFFLINE" | "DELETING" | "DISABLED" | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE" | "OFFLINE" | "DELETING" | "DISABLED" | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The Mesh node that matches the ID.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The Mesh node does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE"
 | "OFFLINE"
 | "DELETING"
 | "DISABLED"
 | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update Mesh node
Description
Update a Mesh node.
```
The authenticated user must have **SYS_ADMIN** permission.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string }
 - Readonlyid: string
 Description
 The ID of the Mesh node to update.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE" | "OFFLINE" | "DELETING" | "DISABLED" | "DRAINING";
 };
 };
 }
 Description
 The request specifying the updated Mesh node.
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE" | "OFFLINE" | "DELETING" | "DISABLED" | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 id?: string;
 lastSeenDate?: number;
 name?: string;
 offline?: boolean;
 rpcId?: string;
 rpcUrl?: string;
 state?: "AVAILABLE" | "OFFLINE" | "DELETING" | "DISABLED" | "DRAINING";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The updated Mesh node.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The request was malformed.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/git/mesh/support-zips

"/api/latest/admin/git/mesh/support-zips": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/octet-stream": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/octet-stream": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get support zips for all Mesh nodes
Description
Get the support zips for all the Mesh nodes.
```
The authenticated user must have **SYS_ADMIN** permission.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: { "application/octet-stream": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/octet-stream": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The support zips for all the Mesh nodes.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/git/mesh/support-zips/{id}

"/api/latest/admin/git/mesh/support-zips/{id}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/octet-stream": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/octet-stream": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get support zip for node
Description
Get the support zip for the Mesh node that matches the specified ID.
```
The authenticated user must have **SYS_ADMIN** permission.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { id: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string }
 - Readonlyid: string
 Description
 The ID of the Mesh node.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: { "application/octet-stream": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/octet-stream": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The support zip for the Mesh node that matches the ID.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The Mesh node does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/groups

"/api/latest/admin/groups": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": { deletable?: boolean; name?: string };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": { deletable?: boolean; name?: string };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": { deletable?: boolean; name?: string };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Remove group
Description
Deletes the specified group, removing them from the system. This also removes any permissions that may have been granted to the group.
```
A user may not delete the last group that is granting them administrative permissions, or a group with greater permissions than themselves.

The authenticated user must have the ADMIN permission to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { name: string }
 - Readonlyname: string
 Description
 The name identifying the group to delete.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: { "application/json": { deletable?: boolean; name?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/json": { deletable?: boolean; name?: string } };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The deleted group.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The request was malformed.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The authenticated user does not have the ADMIN permission.
 - Readonly403: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as the authenticated user has a lower permission level than the group being deleted.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified group does not exist.
 - Readonly409: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as it would lower the authenticated user's permission level.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get groups
Description
Retrieve a page of groups.
```
The authenticated user must have LICENSED_USER permission or higher to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only group names containing the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A page of groups.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not a licensed user.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": { deletable?: boolean; name?: string };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Create group
Description
Create a new group.
```
The authenticated user must have ADMIN permission or higher to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { name: string }
 - Readonlyname: string
 Description
 Name of the group.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: { "application/json": { deletable?: boolean; name?: string } };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/json": { deletable?: boolean; name?: string } };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The newly created group.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The request was malformed.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not an administrator.
 - Readonly409: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A group with this name already exists.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/groups/add-user

"/api/latest/admin/groups/add-user": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { context?: string; itemName?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { context?: string; itemName?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Add user to group
Deprecated
Description
Deprecated since 2.10. Use /rest/users/add-groups instead.
```
Add a user to a group.

In the request entity, the context attribute is the group and the itemName is the user.

The authenticated user must have the ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { context?: string; itemName?: string } } }
- Readonlyresponses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The user was added to the group.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The authenticated user does not have the ADMIN permission.
 - Readonly403: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as it would exceed the server's licensing limit, or the groups permissions exceed the authenticated user's permission level.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user or group does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/groups/add-users

"/api/latest/admin/groups/add-users": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { group?: string; users: readonly string[] };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { group?: string; users: readonly string[] };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Add multiple users to group
Description
Add multiple users to a group.
```
The authenticated user must have the ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": { group?: string; users: readonly string[] };
 };
 }
- Readonlyresponses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 All the users were added to the group
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The authenticated user does not have the ADMIN permission.
 - Readonly403: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as it would exceed the server's licensing limit, or the groups permissions exceed the authenticated user's permission level.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user or group does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/groups/more-members

"/api/latest/admin/groups/more-members": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 context: string;
 filter?: string;
 limit?: number;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 context: string;
 filter?: string;
 limit?: number;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get group members

Description
Retrieves a list of users that are members of a specified group.
The authenticated user must have the LICENSED_USER permission to call this resource.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { context: string; filter?: string; limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { context: string; filter?: string; limit?: number; start?: number }
 - Readonlycontext: string
 Description
 The group which should be used to locate members.
 - Optional Readonlyfilter?: string
 Description
 If specified only users with usernames, display names or email addresses containing the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A page of users.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not a licensed user.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/groups/more-non-members

"/api/latest/admin/groups/more-non-members": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 context: string;
 filter?: string;
 limit?: number;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 context: string;
 filter?: string;
 limit?: number;
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get members not in group

Description
Retrieves a list of users that are not members of a specified group.
The authenticated user must have the LICENSED_USER permission to call this resource.
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { context: string; filter?: string; limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { context: string; filter?: string; limit?: number; start?: number }
 - Readonlycontext: string
 Description
 The group which should be used to locate members.
 - Optional Readonlyfilter?: string
 Description
 If specified only users with usernames, display names or email addresses containing the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A page of users.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not a licensed user.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/groups/remove-user

"/api/latest/admin/groups/remove-user": {
 delete?: undefined;
 get?: undefined;
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { context?: string; itemName?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": { context?: string; itemName?: string };
 };
 };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Remove user from group
Deprecated
Description
Deprecated since 2.10. Use /rest/users/remove-groups instead.
```
Remove a user from a group.

The authenticated user must have the ADMIN permission to call this resource.

In the request entity, the context attribute is the group and the itemName is the user.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { context?: string; itemName?: string } } }
- Readonlyresponses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The user was removed from the group.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The authenticated user does not have the ADMIN permission.
 - Readonly403: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as the group has a higher permission level than the context user.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user or group does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/license

"/api/latest/admin/license": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get license details
Description
Retrieves details about the current license, as well as the current status of the system with regards to the installed license. The status includes the current number of users applied toward the license limit, as well as any status messages about the license (warnings about expiry or user counts exceeding license limits).
```
The authenticated user must have ADMIN permission. Unauthenticated users, and non-administrators, are not permitted to access license details.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently-installed license.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to view the license, or the request is anonymous.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 No license has been installed.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update license
Description
Decodes the provided encoded license and sets it as the active license. If no license was provided, a 400 is returned. If the license cannot be decoded, or cannot be applied, a 409 is returned. Some possible reasons a license may not be applied include:
```
- It is for a different product
- It is already expired


Otherwise, if the license is updated successfully, details for the new license are returned with a 200 response.

Warning: It is possible to downgrade the license during update, applying a license with a lower number of permitted users. If the number of currently-licensed users exceeds the limits of the new license, pushing will be disabled until the licensed user count is brought into compliance with the new license.

The authenticated user must have SYS_ADMIN permission. ADMIN users may view the current license details, but they may not update the license.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 }
 Description
 a JSON payload containing the encoded license to apply
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 creationDate?: number;
 daysBeforeExpiry?: number;
 expiryDate?: number;
 gracePeriodEndDate?: number;
 license?: string;
 maintenanceExpiryDate?: number;
 maximumNumberOfUsers?: number;
 numberOfDaysBeforeExpiry?: number;
 numberOfDaysBeforeGracePeriodExpiry?: number;
 numberOfDaysBeforeMaintenanceExpiry?: number;
 purchaseDate?: number;
 serverId?: string;
 status?: { currentNumberOfUsers?: number; serverId?: string };
 supportEntitlementNumber?: string;
 unlimitedNumberOfUsers?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The newly-installed license.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 No encoded license was provided in the JSON body for the POST.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to update the license.
 - Readonly409: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The encoded license could not be decoded, or it is not valid for use on this server. Some possible reasons a license may not be applied include: it may be for a different product, it may have already expired, or this Bitbucket version doesn't support Server licenses.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/mail-server

"/api/latest/admin/mail-server": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP"
 | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP"
 | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP"
 | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Delete mail configuration
Description
Deletes the current mail configuration.
```
The authenticated user must have the SYS_ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The mail configuration was successfully deleted.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to delete the mail server configuration.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP"
 | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get mail configuration
Description
Retrieves the current mail configuration.
```
The authenticated user must have the SYS_ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP" | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP" | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The mail configuration
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to retrieve the mail configuration.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The mail server hasn't been configured
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP"
 | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP"
 | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update mail configuration
Description
Updates the mail configuration.
```
The authenticated user must have the SYS_ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP" | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 }
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP" | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 hostname?: string;
 password?: string;
 port?: number;
 protocol?: "SMTP" | "SMTPS";
 requireStartTls?: boolean;
 senderAddress?: string;
 username?: string;
 useStartTls?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The updated mail configuration.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The mail configuration was not updated due to a validation error.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to update themail configuration.
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/mail-server/sender-address

"/api/latest/admin/mail-server/sender-address": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": string } };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update mail configuration
Description
Clears the server email address.
```
The authenticated user must have the ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 he server email address was successfully cleared.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions toclear the server email address.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get server mail address

Description
Retrieves the server email address
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The server email address
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 he currently authenticated user has insufficient permissions to retrieve the server email address.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: { content: { "application/json": string } };
 responses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update server mail address
Description
Updates the server email address
```
The authenticated user must have the ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": string } }
- Readonlyresponses: {
 "200": {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: { "application/json": unknown };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The from address used in notification emails
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The server email address was not updated due to a validation error.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to update the server email address.
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/permissions/groups

"/api/latest/admin/permissions/groups": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 name: readonly string[];
 permission: "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_CREATE"
 | "SYS_ADMIN";
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Revoke all global permissions for group
Description
Revoke all global permissions for a group.
```
The authenticated user must have:


- ADMIN permission or higher; and
- greater or equal permissions than the current permission level of the group (a user may not demote the permission level of a group with higher permissions than them)


to call this resource. In addition, a user may not revoke a group's permissions if their own permission level
would be reduced as a result.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { name: string }
 - Readonlyname: string
 Description
 The name of the group
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 All global permissions were revoked from the group.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 TThe currently authenticated user is not an administrator.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified group does not exist.
 - Readonly409: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as it would reduce the currently authenticated user's permission level or the currently authenticated user has a lower permission level than the group they are attempting to modify.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get groups with a global permission
Description
Retrieve a page of groups that have been granted at least one global permission.
```
The authenticated user must have ADMIN permission or higher to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only group names containing the supplied string will be returned
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A page of groups and their highest global permissions.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not an administrator.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 name: readonly string[];
 permission: "ADMIN" | "LICENSED_USER" | "PROJECT_CREATE" | "SYS_ADMIN";
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update global permission for group
Description
Promote or demote a group's global permission level. Available global permissions are:
```
- LICENSED_USER
- PROJECT_CREATE
- ADMIN
- SYS_ADMIN

See the <a href="https://confluence.atlassian.com/display/BitbucketServer/Global+permissions">Bitbucket Data Center documentation</a> for a detailed explanation of what each permission entails.


The authenticated user must have:


- ADMIN permission or higher; and
- the permission they are attempting to grant or higher; and
- greater or equal permissions than the current permission level of the group (a user may not demote the permission level of a group with higher permissions than them)


to call this resource. In addition, a user may not demote a group's permission level if their own permission
level would be reduced as a result.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 name: readonly string[];
 permission: "ADMIN" | "LICENSED_USER" | "PROJECT_CREATE" | "SYS_ADMIN";
 };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: {
 name: readonly string[];
 permission: "ADMIN" | "LICENSED_USER" | "PROJECT_CREATE" | "SYS_ADMIN";
 }
 - Readonlyname: readonly string[]
 Description
 The names of the groups
 - Readonlypermission: "ADMIN" | "LICENSED_USER" | "PROJECT_CREATE" | "SYS_ADMIN"
 Description
 The permission to grant
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The specified permission was granted to the specified user.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The request was malformed or the specified permission does not exist.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not an administrator or doesn't have the specified permission they are attempting to grant.
 - Readonly403: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as it would exceed the server's license limits.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified group does not exist.
 - Readonly409: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as it would reduce the currently authenticated user's permission level or the currently authenticated user has a lower permission level than the group they are attempting to modify.
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/permissions/groups/none

"/api/latest/admin/permissions/groups/none": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get groups with no global permission
Description
Retrieve a page of groups that have no granted global permissions.
```
The authenticated user must have ADMIN permission or higher to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only user names containing the supplied string will be returned
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { deletable?: boolean; name?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A page of groups that have not been granted any global permissions.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not an administrator.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/permissions/users

"/api/latest/admin/permissions/users": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 name: readonly string[];
 permission: "ADMIN"
 | "LICENSED_USER"
 | "PROJECT_CREATE"
 | "SYS_ADMIN";
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Revoke all global permissions for user
Description
Revoke all global permissions for a user.
```
The authenticated user must have:


- ADMIN permission or higher; and
- greater or equal permissions than the current permission level of the user (a user may not demote the permission level of a user with higher permissions than them)


to call this resource. In addition, a user may not demote their own permission level.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { name: string }
 - Readonlyname: string
 Description
 The name of the user
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 All global permissions were revoked from the user.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not an administrator.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user does not exist.
 - Readonly409: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as it would reduce the currently authenticated user's permission level or the currently authenticated user has a lower permission level than the user they are attempting to modify.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get users with a global permission
Description
Retrieve a page of users that have been granted at least one global permission.
```
The authenticated user must have ADMIN permission or higher to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only user names containing the supplied string will be returned
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly { group?: { name?: ... }; permission?: string }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A page of users and their highest global permissions.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not an administrator.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 name: readonly string[];
 permission: "ADMIN" | "LICENSED_USER" | "PROJECT_CREATE" | "SYS_ADMIN";
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update global permission for user
Description
Promote or demote the global permission level of a user. Available global permissions are:
```
- LICENSED_USER
- PROJECT_CREATE
- ADMIN
- SYS_ADMIN


See the <a href="https://confluence.atlassian.com/display/BitbucketServer/Global+permissions">Bitbucket Data Center documentation</a> for a detailed explanation of what each permission entails.


The authenticated user must have:


- ADMIN permission or higher; and
- the permission they are attempting to grant; and
- greater or equal permissions than the current permission level of the user (a user may not demote the permission level of a user with higher permissions than them)


to call this resource. In addition, a user may not demote their own permission level.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 name: readonly string[];
 permission: "ADMIN" | "LICENSED_USER" | "PROJECT_CREATE" | "SYS_ADMIN";
 };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: {
 name: readonly string[];
 permission: "ADMIN" | "LICENSED_USER" | "PROJECT_CREATE" | "SYS_ADMIN";
 }
 - Readonlyname: readonly string[]
 Description
 The names of the users
 - Readonlypermission: "ADMIN" | "LICENSED_USER" | "PROJECT_CREATE" | "SYS_ADMIN"
 Description
 The permission to grant
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The requested permission was granted.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The request was malformed or the specified permission does not exist.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not an administrator or doesn't have the specified permission they are attempting to grant.
 - Readonly403: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as it would exceed the server's license limits.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user does not exist.
 - Readonly409: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as it would reduce the currently authenticated user's permission level or the currently authenticated user has a lower permission level than the user they are attempting to modify.
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/permissions/users/none

"/api/latest/admin/permissions/users/none": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get users with no global permission
Description
Retrieve a page of users that have no granted global permissions.
```
The authenticated user must have ADMIN permission or higher to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only user names containing the supplied string will be returned
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<(...), (...)>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A page of users that have not been granted any global permissions.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not an administrator.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/pull-requests/{scmId}

"/api/latest/admin/pull-requests/{scmId}": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scmId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 commitMessageTemplate?: { body?: string; title?: string };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<string, unknown>;
 name?: string;
 };
 strategies?: readonly {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<(...), (...)>;
 name?: string;
 }[];
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scmId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 mergeConfig?: {
 commitMessageTemplate?: {
 body?: (...)
 | (...);
 title?: (...) | (...);
 };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: (...)
 | (...);
 enabled?: (...) | (...) | (...);
 flag?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 };
 strategies?: readonly {
 description?: ...;
 enabled?: ...;
 flag?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 }[];
 type?: string;
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 commitMessageTemplate?: { body?: string; title?: string };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<string, unknown>;
 name?: string;
 };
 strategies?: readonly {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<(...), (...)>;
 name?: string;
 }[];
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scmId: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 commitMessageTemplate?: { body?: string; title?: string };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<string, unknown>;
 name?: string;
 };
 strategies?: readonly {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<(...), (...)>;
 name?: string;
 }[];
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get merge strategies
Description
Retrieve the merge strategies available for this instance.
```
The user must be authenticated to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scmId: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { scmId: string }
 - ReadonlyscmId: string
 Description
 the id of the scm to get strategies for
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 commitMessageTemplate?: { body?: string; title?: string };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<string, unknown>;
 name?: string;
 };
 strategies?: readonly {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<(...), (...)>;
 name?: string;
 }[];
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 commitMessageTemplate?: { body?: string; title?: string };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<string, unknown>;
 name?: string;
 };
 strategies?: readonly {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<(...), (...)>;
 name?: string;
 }[];
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The merge configuration of this instance.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to see the request repository.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The request repository does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scmId: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 mergeConfig?: {
 commitMessageTemplate?: {
 body?: (...)
 | (...);
 title?: (...) | (...);
 };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: (...)
 | (...);
 enabled?: (...) | (...) | (...);
 flag?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 };
 strategies?: readonly {
 description?: ...;
 enabled?: ...;
 flag?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 }[];
 type?: string;
 };
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 commitMessageTemplate?: { body?: string; title?: string };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<string, unknown>;
 name?: string;
 };
 strategies?: readonly {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<(...), (...)>;
 name?: string;
 }[];
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Update merge strategies
Description
Update the pull request merge strategies for the context repository.
```
The authenticated user must have ADMIN permission to call this resource.

Only the strategies provided will be enabled, only one may be set to default

The commit message template will not be updated if not provided, and will be deleted if the `commitMessageTemplate` attribute is empty, i.e: `commitMessageTemplate: {}`.

An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty `mergeConfig` attribute. i.e:
```
{
 "mergeConfig": {}
}
```

Upon completion of this request, the effective configuration will be the default configuration.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { scmId: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { scmId: string }
 - ReadonlyscmId: string
 Description
 the id of the scm to get strategies for
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 mergeConfig?: {
 commitMessageTemplate?: {
 body?: (...) | (...);
 title?: (...) | (...);
 };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: (...)
 | (...);
 enabled?: (...) | (...) | (...);
 flag?: (...) | (...);
 id?: (...) | (...);
 links?: (...) | (...);
 name?: (...) | (...);
 };
 strategies?: readonly {
 description?: ...;
 enabled?: ...;
 flag?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 }[];
 type?: string;
 };
 };
 };
 }
 Description
 the settings
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 commitMessageTemplate?: { body?: string; title?: string };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<string, unknown>;
 name?: string;
 };
 strategies?: readonly {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<(...), (...)>;
 name?: string;
 }[];
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 commitMessageTemplate?: { body?: string; title?: string };
 commitSummaries?: number;
 defaultStrategy?: {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<string, unknown>;
 name?: string;
 };
 strategies?: readonly {
 description?: string;
 enabled?: boolean;
 flag?: string;
 id?: string;
 links?: Record<(...), (...)>;
 name?: string;
 }[];
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The repository pull request merge strategies for the context repository.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The repository pull request merge strategies were not updated due to a validation error.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to administrate thespecified repository.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified repository does not exist.
 - Readonly409: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 Setting or deleting merge configurations isn't supported on archived repositories.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/rate-limit/history

"/api/latest/admin/rate-limit/history": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: {
 limit?: number;
 order?: "FREQUENCY" | "NEWEST";
 start?: number;
 };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 lastRejectTime?: number;
 rejectCount?: number;
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { limit?: number; order?: "FREQUENCY" | "NEWEST"; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 lastRejectTime?: number;
 rejectCount?: number;
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get rate limit history
Description
Retrieves the recent rate limit history for the instance.
```
The authenticated user must have the ADMIN permission to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { limit?: number; order?: "FREQUENCY" | "NEWEST"; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; order?: "FREQUENCY" | "NEWEST"; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlyorder?: "FREQUENCY" | "NEWEST"
 Description
 An optional sort category to arrange the results in descending order
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 lastRejectTime?: number;
 rejectCount?: number;
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 lastRejectTime?: number;
 rejectCount?: number;
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing a page of aggregated counters for users who have been recently rate limited.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The sort query parameter is invalid.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to retrieve rate limit history.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/rate-limit/settings

"/api/latest/admin/rate-limit/settings": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get rate limit settings
Description
Retrieves the rate limit settings for the instance.
```
The user must be authenticated to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the rate limit plugin settings for the instance.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to retrieve rate limit settings.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Set rate limit
Description
Sets the rate limit settings for the instance.
```
The authenticated user must have ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 }
 Description
 Sets the rate limit settings for the instance.
```
The authenticated user must have ADMIN permission to call this resource.
```
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 defaultSettings?: { capacity?: number; fillRate?: number };
 enabled?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the updated rate limit plugin settings for the instance.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 One of the following error cases occurred (check the error message for more details):
 
 - The request is empty - The enabled field of the request is not a boolean - The defaultSettings field of the request does not contain both capacity and fillRate - The capacity and fillRate are not positive integers
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to set rate limit settings.
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/rate-limit/settings/users

"/api/latest/admin/rate-limit/settings/users": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 settings?: { capacity?: ...; fillRate?: ... };
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 whitelisted?: boolean;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 usernames?: readonly string[];
 whitelisted?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 settings?: { capacity?: ...; fillRate?: ... };
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 whitelisted?: boolean;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get rate limit settings for user
Description
Retrieves the user-specific rate limit settings for the given user.
```
The authenticated user must have ADMIN permission to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 Optional filter
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 settings?: { capacity?: ...; fillRate?: ... };
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 whitelisted?: boolean;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 settings?: { capacity?: ...; fillRate?: ... };
 user?: {
 active?: ...;
 avatarUrl?: ...;
 displayName?: ...;
 emailAddress?: ...;
 id?: ...;
 links?: ...;
 name?: ...;
 slug?: ...;
 type?: ...;
 };
 whitelisted?: boolean;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing all the user-specific rate limit settings filtered by the optional filter.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to retrieve rate limit settings.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 usernames?: readonly string[];
 whitelisted?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Set rate limit settings for users
Description
Sets the given rate limit settings for the given users.
```
The authenticated user must have ADMIN permission to call this resource.
```
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 usernames?: readonly string[];
 whitelisted?: boolean;
 };
 };
 }
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the updated user settings.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 One of the following valid state error cases occurred (check the error message for more details):
 
 - The request is empty - No users are provided in the request - One or more of the users are invalid - Whitelisted is false or not provided, and no settings are provided either - Whitelisted is false or not provided, settings are provided, but do not contain both capacity and fillRate - Whitelisted is false or not provided, settings are provided, but capacity and fillRate are not positive integers - Whitelisted is true, and settings are provided (only one must be provided)
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to set user settings.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/rate-limit/settings/users/{userSlug}

"/api/latest/admin/rate-limit/settings/users/{userSlug}": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 whitelisted?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Delete user specific rate limit settings
Description
Deletes the user-specific rate limit settings for the given user.
```
The authenticated user must have ADMIN permission to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { userSlug: string }
 - ReadonlyuserSlug: string
 Description
 The user slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the user settings have been deleted.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to retrieve rate limit settings.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user does not exist, or has no settings.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get user specific rate limit settings
Description
Retrieves the user-specific rate limit settings for the given user.
```
To call this resource, the user must be authenticated and either have ADMIN permission or be the same user as the one whose settings are requested. A user with ADMIN permission cannot get the settings of a user with SYS_ADMIN permission.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { userSlug: string }
 - ReadonlyuserSlug: string
 Description
 The user slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the user-specific rate limit settings for the given user.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to retrieve rate limit settings.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user does not exist, or has no settings.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 whitelisted?: boolean;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Set rate limit settings for user
Description
Sets the given rate limit settings for the given user.
```
The authenticated user must have ADMIN permission to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path: { userSlug: string };
 query?: undefined;
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { userSlug: string }
 - ReadonlyuserSlug: string
 Description
 The user slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 whitelisted?: boolean;
 };
 };
 }
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 settings?: { capacity?: number; fillRate?: number };
 user?: {
 active?: boolean;
 avatarUrl?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 links?: Record<string, unknown>;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 whitelisted?: boolean;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A response containing the updated user settings
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 One of the following valid state error cases occurred (check the error message for more details):
 
 - The request is empty - Whitelisted is false or not provided, and no settings are provided either - Whitelisted is false or not provided, settings are provided, but do not contain both capacity and fillRate - Whitelisted is false or not provided, settings are provided, but capacity and fillRate are not positive integers - Whitelisted is true, and settings are provided (only one must be provided)
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user has insufficient permissions to set user settings.
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/user-directories

"/api/latest/admin/user-directories": {
 delete?: undefined;
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { includeInactive?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 description?: string;
 name?: string;
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post?: undefined;
 put?: undefined;
 trace?: undefined;
}

Type declaration

Optional Readonlydelete?: undefined
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { includeInactive?: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 description?: string;
 name?: string;
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get directories
Description
Retrieve a list of active directories.
```
 The authenticated user must have the ADMIN permission to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { includeInactive?: string };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { includeInactive?: string }
 - Optional ReadonlyincludeInactive?: string
 Description
 Set true to include inactive directories; otherwise, false to only return active directories.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 description?: string;
 name?: string;
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 active?: boolean;
 description?: string;
 name?: string;
 type?: string;
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A list of directories
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not an administrator
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly`/api/latest/admin/users

"/api/latest/admin/users": {
 delete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<string, unknown>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 get: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 head?: undefined;
 options?: undefined;
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 patch?: undefined;
 post: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 addToDefaultGroup?: boolean;
 displayName: string;
 emailAddress: string;
 name: string;
 notify?: boolean;
 password?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 put: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: undefined;
 };
 requestBody?: {
 content: {
 "application/json": {
 displayName?: string;
 email?: string;
 name?: string;
 };
 };
 };
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<string, unknown>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
 };
 trace?: undefined;
}

Type declaration

Readonlydelete: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<string, unknown>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Remove user
Description
Deletes the specified user, removing them from the system. This also removes any permissions that may have been granted to the user.
```
A user may not delete themselves, and a user with ADMIN permissions may not delete a user with SYS_ADMINpermissions.

The authenticated user must have the ADMIN permission to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: { name: string };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { name: string }
 - Readonlyname: string
 Description
 The username identifying the user to delete.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<string, unknown>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "404": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<string, unknown>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The deleted user.
 - Readonly400: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The request was malformed.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The authenticated user does not have the ADMIN permission.
 - Readonly403: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as the authenticated user has a lower permission level than the user being deleted.
 - Readonly404: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The specified user does not exist.
 - Readonly409: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The action was disallowed as a user can not delete themselves.
Readonlyget: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 };
 requestBody?: undefined;
 responses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Get users
Description
Retrieve a page of users.
```
 The authenticated user must have the LICENSED_USER permission to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query?: { filter?: string; limit?: number; start?: number };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only users with usernames, display name or email addresses containing the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: {
 "200": {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 }
 - Readonly200: {
 content: {
 "application/json": {
 isLastPage?: boolean;
 limit?: number;
 nextPageStart?: number;
 size?: number;
 start?: number;
 values?: readonly {
 active?: boolean;
 avatarUrl?: string;
 deletable?: boolean;
 directoryName?: string;
 displayName?: string;
 emailAddress?: string;
 id?: number;
 lastAuthenticationTimestamp?: number;
 links?: Record<(...), (...)>;
 mutableDetails?: boolean;
 mutableGroups?: boolean;
 name?: string;
 slug?: string;
 type?: "NORMAL" | "SERVICE";
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 A page of users.
 - Readonly401: {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 }
 Description
 The currently authenticated user is not a licensed user.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: {
 parameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 addToDefaultGroup?: boolean;
 displayName: string;
 emailAddress: string;
 name: string;
 notify?: boolean;
 password?: string;
 };
 };
 requestBody?: undefined;
 responses: {
 "204": {
 content?: undefined;
 headers: Readonly<Record<string, unknown>>;
 };
 "400": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "401": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "403": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 "409": {
 content: {
 "application/json": {
 errors?: readonly {
 context?: string;
 exceptionName?: string;
 message?: string;
 }[];
 };
 };
 headers: Readonly<Record<string, unknown>>;
 };
 };
}
Create user
Description
Creates a new user from the assembled query parameters.
```
The default group can be used to control initial permissions for new users, such as granting users the ability to login or providing read access to certain projects or repositories. If the user is not added to the default group, they may not be able to login after their account is created until explicit permissions are configured.

The authenticated user must have the ADMIN permission to call this resource.
```
- Readonlyparameters: {
 cookie?: undefined;
 header?: undefined;
 path?: undefined;
 query: {
 addToDefaultGroup?: boolean;
 displayName: string;
 emailAddress: string;
 name: string;
 notify?: boolean;
 password?: string;
 };
 }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: {
 addToDefaultGroup?: boolean;
 displayName: string;
 emailAddress: string;
 name: string;
 notify?: boolean;
 password?: string;
 }
 - Optional ReadonlyaddToDefaultGroup?: boolean
 Description
 Set true to add the user to the default group, which can be used to grant them a set of initial permissions; otherwise, false to not add them to a group.
 - ReadonlydisplayName: string
 Description
 The display name for the new user.
 - ReadonlyemailAddress: string
 Description
 The e-mail address for the new user.
 - Readonlyname: string
 Description
 The username for the new user.
 - Optional Readonlynotify?: boolean
 Description
 If present and not false instead of requiring a password, the create user will be notified via email their account has been created and requires a password to be reset. This option can only be used if a mail server has been configured.
 - Optional Readonlypassword?: string
 Description
 The password for the new user. Required if the notify parameter is not present or is set to false
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The user was successfully created.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not an administrator.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Adding the user to the default group would exceed the server's license limit.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Another user with the same name already exists.
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { displayName?: string; email?: string; name?: string; }; }; }; responses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; deletable?: boolean; directoryName?: string; displayName?: string; emailAddress?: string; id?: number; lastAuthenticationTimestamp?: number; links?: Record<string, unknown>; mutableDetails?: boolean; mutableGroups?: boolean; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update user details
Description
Update a user's details.
The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { displayName?: string; email?: string; name?: string; }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; deletable?: boolean; directoryName?: string; displayName?: string; emailAddress?: string; id?: number; lastAuthenticationTimestamp?: number; links?: Record<string, unknown>; mutableDetails?: boolean; mutableGroups?: boolean; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; avatarUrl?: string; deletable?: boolean; directoryName?: string; displayName?: string; emailAddress?: string; id?: number; lastAuthenticationTimestamp?: number; links?: Record<string, unknown>; mutableDetails?: boolean; mutableGroups?: boolean; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated user.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user does not have the ADMIN permission or has a lower permission level than the user being updated.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified user does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/admin/users/add-group`

"/api/latest/admin/users/add-group": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": { context?: string; itemName?: string };
            };
        };
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { context?: string; itemName?: string }; }; }; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add user to group
Deprecated
Description
Deprecated since 2.10. Use /rest/users/add-groups instead.
Add a user to a group. This is very similar to <code>groups/add-user</code>, but with the context and itemName attributes of the supplied request entity reversed. On the face of it this may appear redundant, but it facilitates a specific UI component in the application. In the request entity, the context attribute is the user and the itemName is the group. The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { context?: string; itemName?: string } } }
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user was added to the group
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user does not have the ADMIN permission.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would exceed the server's licensing limit, or the groups permissions exceed the authenticated user's permission level.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified user or group does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/admin/users/add-groups`

"/api/latest/admin/users/add-groups": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": { groups: readonly string[]; user?: string };
            };
        };
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { groups: readonly string[]; user?: string }; }; }; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add user to groups
Description
Add a user to one or more groups.
The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { groups: readonly string[]; user?: string }; }; }
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user was added to all the groups
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user does not have the ADMIN permission.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would exceed the server's licensing limit, or the groups permissions exceed the authenticated user's permission level.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified user or group does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/admin/users/captcha`

"/api/latest/admin/users/captcha": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query: { name: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query: { name: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Clear CAPTCHA for user
Description
Clears any CAPTCHA challenge that may constrain the user with the supplied username when they authenticate. Additionally any counter or metric that contributed towards the user being issued the CAPTCHA challenge (for instance too many consecutive failed logins) will also be reset.
The authenticated user must have the ADMIN permission to call this resource, and may not clear the CAPTCHA of a user with greater permissions than themselves.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query: { name: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { name: string }
 - Readonlyname: string
 Description
 The username
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The CAPTCHA was successfully cleared.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user does not have the ADMIN permission.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as the authenticated user has a lower permission level than the user to clear captcha for.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified user does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/admin/users/credentials`

"/api/latest/admin/users/credentials": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    name?: string;
                    password?: string;
                    passwordConfirm?: string;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { name?: string; password?: string; passwordConfirm?: string; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Set password for user
Description
Update a user's password.
The authenticated user must have the ADMIN permission to call this resource, and may not update the password of a user with greater permissions than themselves.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { name?: string; password?: string; passwordConfirm?: string; }; }; }
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The user's password was successfully updated.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user does not have the ADMIN permission or has a lower permission level than the user having their password updated.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified user does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/admin/users/erasure`

"/api/latest/admin/users/erasure": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query: { name: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query: { name: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { newIdentifier?: string } };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query: { name: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Check user removal
Description
Validate if a user can be erased.
A username is only valid for erasure if it exists as the username of a deleted user. This endpoint will return an appropriate error response if the supplied username is invalid for erasure. This endpoint does not perform the actual user erasure, and will not modify the application in any way. The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query: { name: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { name: string }
 - Readonlyname: string
 Description
 The username of the user to validate erasability for.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 the user is erasable
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed (e.g. if no username was supplied).
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user does not have the ADMIN permission or has a lower permission level than the user being erased.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested username does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested username is the username of a not deleted user.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query: { name: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { newIdentifier?: string } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Erase user information
Description
Erases personally identifying user data for a deleted user.
References in the application to the original username will be either removed or updated to a new non-identifying username. Refer to the <a href="https://confluence.atlassian.com/gdpr/bitbucket-right-to-erasure-949770560.html">support guide</a> for details about what data is and isn't erased. User erasure can only be performed on a deleted user. If the user has not been deleted first then this endpoint will return a bad request and no erasure will be performed. Erasing user data is irreversible and may lead to a degraded user experience. This method should not be used as part of a standard user deletion and cleanup process. Plugins can participate in user erasure by defining a <code><user-erasure-handler></code> module. If one or more plugin modules fail, an error summary of the failing modules is returned. The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query: { name: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { name: string }
 - Readonlyname: string
 Description
 The username identifying the user to erase.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { newIdentifier?: string } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { newIdentifier?: string } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The identifier of the erased user.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed (e.g. if no username was supplied).
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user does not have the ADMIN permission or has a lower permission level than the user being erased.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested username does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested username is the username of a not deleted user.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/admin/users/more-members`

"/api/latest/admin/users/more-members": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query: {
                context: string;
                filter?: string;
                limit?: number;
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            deletable?: boolean;
                            directoryName?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            lastAuthenticationTimestamp?: number;
                            links?: Record<(...), (...)>;
                            mutableDetails?: boolean;
                            mutableGroups?: boolean;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query: { context: string; filter?: string; limit?: number; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; deletable?: boolean; directoryName?: string; displayName?: string; emailAddress?: string; id?: number; lastAuthenticationTimestamp?: number; links?: Record<(...), (...)>; mutableDetails?: boolean; mutableGroups?: boolean; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get groups for user
Description
Retrieves a list of users that are not members of a specified group.
The authenticated user must have the LICENSED_USER permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query: { context: string; filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { context: string; filter?: string; limit?: number; start?: number }
 - Readonlycontext: string
 Description
 The group which should be used to locate members.
 - Optional Readonlyfilter?: string
 Description
 If specified only users with usernames, display names or email addresses containing the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; deletable?: boolean; directoryName?: string; displayName?: string; emailAddress?: string; id?: number; lastAuthenticationTimestamp?: number; links?: Record<(...), (...)>; mutableDetails?: boolean; mutableGroups?: boolean; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; deletable?: boolean; directoryName?: string; displayName?: string; emailAddress?: string; id?: number; lastAuthenticationTimestamp?: number; links?: Record<(...), (...)>; mutableDetails?: boolean; mutableGroups?: boolean; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of users.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a licensed user.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/admin/users/more-non-members`

"/api/latest/admin/users/more-non-members": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query: {
                context: string;
                filter?: string;
                limit?: number;
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly { deletable?: boolean; name?: string }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query: { context: string; filter?: string; limit?: number; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { deletable?: boolean; name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find other groups for user
Description
Retrieves a list of groups the specified user is not a member of.
The authenticated user must have the LICENSED_USER permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query: { context: string; filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Readonlyquery: { context: string; filter?: string; limit?: number; start?: number }
 - Readonlycontext: string
 Description
 The user which should be used to locate groups.
 - Optional Readonlyfilter?: string
 Description
 If specified only groups with names containing the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { deletable?: boolean; name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { deletable?: boolean; name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of groups.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a licensed user.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/admin/users/remove-group`

"/api/latest/admin/users/remove-group": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": { context?: string; itemName?: string };
            };
        };
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { context?: string; itemName?: string }; }; }; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Remove user from group
Description
Remove a user from a group. This is very similar to groups/remove-user, but with the context and itemName attributes of the supplied request entity reversed. On the face of it this may appear redundant, but it facilitates a specific UI component in the application.
In the request entity, the context attribute is the user and the itemName is the group. The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { context?: string; itemName?: string } } }
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user was removed from the group.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user does not have the ADMIN permission.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as the group has a higher permission level than the context user.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified user or group does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/admin/users/rename`

"/api/latest/admin/users/rename": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: { "application/json": { name?: string; newName?: string } };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        avatarUrl?: string;
                        deletable?: boolean;
                        directoryName?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        lastAuthenticationTimestamp?: number;
                        links?: Record<string, unknown>;
                        mutableDetails?: boolean;
                        mutableGroups?: boolean;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { name?: string; newName?: string } }; }; responses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; deletable?: boolean; directoryName?: string; displayName?: string; emailAddress?: string; id?: number; lastAuthenticationTimestamp?: number; links?: Record<string, unknown>; mutableDetails?: boolean; mutableGroups?: boolean; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Rename user
Description
Rename a user.
The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { name?: string; newName?: string } } }
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; deletable?: boolean; directoryName?: string; displayName?: string; emailAddress?: string; id?: number; lastAuthenticationTimestamp?: number; links?: Record<string, unknown>; mutableDetails?: boolean; mutableGroups?: boolean; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; avatarUrl?: string; deletable?: boolean; directoryName?: string; displayName?: string; emailAddress?: string; id?: number; lastAuthenticationTimestamp?: number; links?: Record<string, unknown>; mutableDetails?: boolean; mutableGroups?: boolean; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The renamed user.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user does not have the ADMIN permission or has a lower permission level than the user being renamed.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified user does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/application-properties`

"/api/latest/application-properties": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        buildDate?: string;
                        buildNumber?: string;
                        displayName?: string;
                        version?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { buildDate?: string; buildNumber?: string; displayName?: string; version?: string; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get application properties
Description
Retrieve version information and other application properties.
No authentication is required to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { buildDate?: string; buildNumber?: string; displayName?: string; version?: string; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { buildDate?: string; buildNumber?: string; displayName?: string; version?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The application properties
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/build/capabilities`

"/api/latest/build/capabilities": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { buildStatus?: readonly string[] } };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { buildStatus?: readonly string[] } }; headers: Readonly<Record<string, unknown>>; }; }; }
Get build capabilities
Description
Returns the build capabilities of this instance
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { buildStatus?: readonly string[] } }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { buildStatus?: readonly string[] } }; headers: Readonly<Record<string, unknown>>; }
 Description
 capabilities
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/dashboard/pull-request-suggestions`

"/api/latest/dashboard/pull-request-suggestions": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { changesSince?: string; limit?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            changeTme?: number;
                            fromRef?: { displayId?: ...; id?: ...; type?: ... };
                            refChange?: {
                                fromHash?: ...;
                                ref?: ...;
                                refId?: ...;
                                toHash?: ...;
                                type?: ...;
                            };
                            repository?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                origin?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            toRef?: { displayId?: ...; id?: ...; type?: ... };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { changesSince?: string; limit?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { changeTme?: number; fromRef?: { displayId?: ...; id?: ...; type?: ... }; refChange?: { fromHash?: ...; ref?: ...; refId?: ...; toHash?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; toRef?: { displayId?: ...; id?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request suggestions
Description
Retrieves a page of suggestions for pull requests that the currently authenticated user may wish to raise. Such suggestions are based on ref changes occurring and so contain the ref change that prompted the suggestion plus the time the change event occurred. Changes will be returned in descending order based on the time the change that prompted the suggestion occurred.
Note that although the response is a page object, the interface does not support paging, however a limit can be applied to the size of the returned page.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { changesSince?: string; limit?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { changesSince?: string; limit?: string }
 - Optional ReadonlychangesSince?: string
 Description
 restrict pull request suggestions to be based on events that occurred since some timein the past. This is expressed in seconds since "now". So to return suggestionsbased only on activity within the past 48 hours, pass a value of 172800.
 - Optional Readonlylimit?: string
 Description
 restricts the result set to return at most this many suggestions.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { changeTme?: number; fromRef?: { displayId?: ...; id?: ...; type?: ... }; refChange?: { fromHash?: ...; ref?: ...; refId?: ...; toHash?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; toRef?: { displayId?: ...; id?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { changeTme?: number; fromRef?: { displayId?: ...; id?: ...; type?: ... }; refChange?: { fromHash?: ...; ref?: ...; refId?: ...; toHash?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; toRef?: { displayId?: ...; id?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of pull requests that match the search criteria.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The current user is not authenticated
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/dashboard/pull-requests`

"/api/latest/dashboard/pull-requests": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                closedSince?: string;
                limit?: number;
                order?: string;
                participantStatus?: string;
                role?: string;
                start?: number;
                state?: string;
                user?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            closed?: boolean;
                            closedDate?: number;
                            createdDate?: number;
                            description?: string;
                            descriptionAsHtml?: string;
                            draft?: boolean;
                            fromRef?: {
                                displayId?: ...;
                                id?: ...;
                                latestCommit?: ...;
                                repository?: ...;
                                type?: ...;
                            };
                            htmlDescription?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            locked?: boolean;
                            open?: boolean;
                            participants?: readonly (...)[];
                            reviewers?: readonly (...)[];
                            state?: "DECLINED" | "MERGED" | "OPEN";
                            title?: string;
                            toRef?: {
                                displayId?: ...;
                                id?: ...;
                                latestCommit?: ...;
                                repository?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { closedSince?: string; limit?: number; order?: string; participantStatus?: string; role?: string; start?: number; state?: string; user?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; htmlDescription?: string; id?: number; links?: Record<(...), (...)>; locked?: boolean; open?: boolean; participants?: readonly (...)[]; reviewers?: readonly (...)[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull requests for a user
Description
Retrieve a page of pull requests where a user is involved as either a reviewer, author or a participant. The request may be filtered by pull request state, role or participant status.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { closedSince?: string; limit?: number; order?: string; participantStatus?: string; role?: string; start?: number; state?: string; user?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { closedSince?: string; limit?: number; order?: string; participantStatus?: string; role?: string; start?: number; state?: string; user?: string; }
 - Optional ReadonlyclosedSince?: string
 Description
 (optional, defaults to returning pull requests regardless of closed since date). Permits returning only pull requests with a closed timestamp set more recently that (now - closedSince). Units are in seconds. So for example if closed since 86400 is set only pull requests closed in the previous 24 hours will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyorder?: string
 Description
 (optional, defaults to NEWEST) the order/(s) to return pull requests in; can choose from OLDEST (as in: "oldest first"), NEWEST, DRAFT_STATUS, PARTICIPANT_STATUS, and/or CLOSED_DATE. Where CLOSED_DATE is specified and the result set includes pull requests that are not in the closed state, these pull requests will appear first in the result set, followed by most recently closed pull requests.
 - Optional ReadonlyparticipantStatus?: string
 Description
 (optional, defaults to returning pull requests with any participant status). A comma separated list of participant status. That is, one or more of UNAPPROVED, NEEDS_WORK, or APPROVED.
 - Optional Readonlyrole?: string
 Description
 (optional, defaults to returning pull requests for any role). If a role is supplied only pull requests where the authenticated user is a participant in the given role will be returned. Either REVIEWER, AUTHOR or PARTICIPANT.
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlystate?: string
 Description
 (optional, defaults to returning pull requests in any state). If a state is supplied only pull requests in the specified state will be returned. Either OPEN, DECLINED or MERGED. Omit this parameter to return pull request in any state.
 - Optional Readonlyuser?: string
 Description
 The name of the involved user, defaults to the current user.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; htmlDescription?: string; id?: number; links?: Record<(...), (...)>; locked?: boolean; open?: boolean; participants?: readonly (...)[]; reviewers?: readonly (...)[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; htmlDescription?: string; id?: number; links?: Record<(...), (...)>; locked?: boolean; open?: boolean; participants?: readonly (...)[]; reviewers?: readonly (...)[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of pull requests that match the search criteria.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The current user is not authenticated
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/deployment/capabilities`

"/api/latest/deployment/capabilities": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get deployment capabilities
Description
Returns the Deployment capabilities of this instance
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 capabilities
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 This instance of Bitbucket Data Center does not support deployments (for example, it has been disabled using the property 'plugin.deployment.capability.disabled').
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/groups`

"/api/latest/groups": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { filter?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly string[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { filter?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get group names
Description
Retrieve a page of group names.
The authenticated user must have LICENSED_USER permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of group names.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a project administrator.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/hook-scripts`

"/api/latest/hook-scripts": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "multipart/form-data": {
                    content?: string;
                    description?: string;
                    name?: string;
                    type?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdDate?: string;
                        description?: string;
                        id?: number;
                        name?: string;
                        pluginKey?: string;
                        type?: "POST"
                        | "PRE";
                        updatedDate?: string;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "multipart/form-data": { content?: string; description?: string; name?: string; type?: string; }; }; }; responses: { "200": { content: { "application/json": { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create a new hook script
Description
Create a new hook script.
This endpoint requires **SYS_ADMIN** permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "multipart/form-data": { content?: string; description?: string; name?: string; type?: string; }; }; }
 Description
 The multipart form data containing the hook script
- Readonlyresponses: { "200": { content: { "application/json": { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created hook script.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The hook script was not created due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/hook-scripts/{scriptId}`

"/api/latest/hook-scripts/{scriptId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scriptId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scriptId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdDate?: string;
                        description?: string;
                        id?: number;
                        name?: string;
                        pluginKey?: string;
                        type?: "POST"
                        | "PRE";
                        updatedDate?: string;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scriptId: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "*/*": { content?: string; description?: string; name?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdDate?: string;
                        description?: string;
                        id?: number;
                        name?: string;
                        pluginKey?: string;
                        type?: "POST"
                        | "PRE";
                        updatedDate?: string;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "422": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { scriptId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a hook script.
Description
Deletes a registered hook script.
This endpoint requires **SYS_ADMIN** permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { scriptId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { scriptId: string }
 - ReadonlyscriptId: string
 Description
 The ID of the hook script to delete
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The hook script was deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied hook script ID.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { scriptId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a hook script
Description
Retrieves a hook script by ID.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { scriptId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { scriptId: string }
 - ReadonlyscriptId: string
 Description
 The ID of the hook script to retrieve
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The hook script.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The hook script ID supplied does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { scriptId: string }; query?: undefined; }; requestBody?: { content: { "*/*": { content?: string; description?: string; name?: string }; }; }; responses: { "200": { content: { "application/json": { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "422": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update a hook script
Description
Updates a hook script.
This endpoint requires **SYS_ADMIN** permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { scriptId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { scriptId: string }
 - ReadonlyscriptId: string
 Description
 The ID of the hook script
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "*/*": { content?: string; description?: string; name?: string }; }; }
 Description
 The multipart form data containing the hook script
- Readonlyresponses: { "200": { content: { "application/json": { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "422": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated hook script.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The hook script ID supplied does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A hook script with the same name already exists.
 - Readonly422: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One or more fields to update must be specified: content, description and/or name.
Optional Readonlytrace?: undefined

`Readonly/api/latest/hook-scripts/{scriptId}/content`

"/api/latest/hook-scripts/{scriptId}/content": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scriptId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { scriptId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get hook script content
Description
Retrieves the hook script content.
This endpoint requires **SYS_ADMIN** permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { scriptId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { scriptId: string }
 - ReadonlyscriptId: string
 Description
 The ID of the hook script
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The hook script content.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The hook script ID supplied does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/hooks/{hookKey}/avatar`

"/api/latest/hooks/{hookKey}/avatar": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { hookKey: string };
            query?: { version?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { hookKey: string }; query?: { version?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get project avatar
Description
Retrieve the avatar for the project matching the supplied moduleKey.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { hookKey: string }; query?: { version?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { hookKey: string }
 - ReadonlyhookKey: string
 Description
 The complete module key of the hook module.
 - Optional Readonlyquery?: { version?: string }
 - Optional Readonlyversion?: string
 Description
 (optional) Version used for HTTP caching only - any non-blank version will result in a large max-age Cache-Control header. Note that this does not affect the Last-Modified header.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The avatar of the project matching the supplied moduleKey.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/inbox/pull-requests`

"/api/latest/inbox/pull-requests": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { limit?: number; role?: string; start?: number };
        };
        requestBody?: undefined;
        responses: {
            default: {
                content: { "application/json;charset=UTF-8": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; role?: string; start?: number }; }; requestBody?: undefined; responses: { default: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull requests in inbox
Description
Returns a page of pull requests in the user's inbox.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; role?: string; start?: number }; }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { default: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonlydefault: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 default response
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/inbox/pull-requests/count`

"/api/latest/inbox/pull-requests/count": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            default: {
                content: { "application/json;charset=UTF-8": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { default: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }; }; }
Get total number of pull requests in inbox
Description
Returns the total number of pull requests in the user's inbox
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { default: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonlydefault: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 default response
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/labels`

"/api/latest/labels": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { limit?: number; prefix?: string; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly { name?: string }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; prefix?: string; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all labels
Description
Returns a paged response of all the labels in the system.
The user needs to be authenticated to use this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; prefix?: string; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; prefix?: string; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyprefix?: string
 Description
 (optional) prefix to filter the labels on.
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Page of returned labels.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user is currently not authenticated.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/labels/{labelName}`

"/api/latest/labels/{labelName}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { labelName: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { name?: string } };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { labelName: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { name?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get label
Description
Returns a label.
The user needs to be authenticated to use this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { labelName: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { labelName: string }
 - ReadonlylabelName: string
 Description
 the label name
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { name?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { name?: string } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The label.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user is currently not authenticated.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified label does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/labels/{labelName}/labeled`

"/api/latest/labels/{labelName}/labeled": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { labelName: string };
            query?: { limit?: number; start?: number; type?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            labelableType?: "REPOSITORY";
                            links?: Record<(...), (...)>;
                            name?: string;
                            origin?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            partition?: number;
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            public?: boolean;
                            relatedLinks?: Record<(...), (...)>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { labelName: string }; query?: { limit?: number; start?: number; type?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; labelableType?: "REPOSITORY"; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get labelables for label
Description
Returns a page of labelables for a given label.
Only labelables that the authenticated user has view access to will be returned.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { labelName: string }; query?: { limit?: number; start?: number; type?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { labelName: string }
 - ReadonlylabelName: string
 Description
 The page of labelables.
 - Optional Readonlyquery?: { limit?: number; start?: number; type?: string }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlytype?: string
 Description
 the type of labelables to be returned. Supported values: REPOSITORY
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; labelableType?: "REPOSITORY"; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; labelableType?: "REPOSITORY"; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The page of labelables.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The type of labelable is incorrect, correct values are REPOSITORY.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the labelables
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified label does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/logs/logger/{loggerName}`

"/api/latest/logs/logger/{loggerName}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { loggerName: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { logLevel?: string } };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { loggerName: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { logLevel?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get current log level
Description
Retrieve the current log level for a given logger.
The authenticated user must have ADMIN permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { loggerName: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { loggerName: string }
 - ReadonlyloggerName: string
 Description
 The name of the logger.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { logLevel?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { logLevel?: string } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The log level of the logger.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the log level.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/logs/logger/{loggerName}/{levelName}`

"/api/latest/logs/logger/{loggerName}/{levelName}": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { levelName: string; loggerName: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { levelName: string; loggerName: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Set log level
Description
Set the current log level for a given logger.
The authenticated user must have ADMIN permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { levelName: string; loggerName: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { levelName: string; loggerName: string }
 - ReadonlylevelName: string
 Description
 The level to set the logger to. Either TRACE, DEBUG, INFO, WARN or ERROR
 - ReadonlyloggerName: string
 Description
 The name of the logger.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The log level was successfully changed.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The log level was invalid.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to set the log level.
Optional Readonlytrace?: undefined

`Readonly/api/latest/logs/rootLogger`

"/api/latest/logs/rootLogger": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { logLevel?: string } };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { logLevel?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get root log level
Description
Retrieve the current log level for the root logger.
The authenticated user must have ADMIN permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { logLevel?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { logLevel?: string } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The log level of the logger.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the log level.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/logs/rootLogger/{levelName}`

"/api/latest/logs/rootLogger/{levelName}": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { levelName: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { levelName: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Set root log level
Description
Set the current log level for the root logger.
The authenticated user must have ADMIN permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { levelName: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { levelName: string }
 - ReadonlylevelName: string
 Description
 the level to set the logger to. Either TRACE, DEBUG, INFO, WARN or ERROR
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The log level was successfully changed.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The log level was invalid.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to set the log level.
Optional Readonlytrace?: undefined

`Readonly/api/latest/markup/preview`

"/api/latest/markup/preview": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                hardwrap?: string;
                htmlEscape?: string;
                includeHeadingId?: string;
                urlMode?: string;
            };
        };
        requestBody?: { content: { "*/*": string } };
        responses: {
            "200": {
                content: { "application/json": { html?: string } };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; urlMode?: string; }; }; requestBody?: { content: { "*/*": string } }; responses: { "200": { content: { "application/json": { html?: string } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Preview markdown render
Description
Preview generated HTML for the given markdown content.
Only authenticated users may call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; urlMode?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; urlMode?: string; }
 - Optional Readonlyhardwrap?: string
 Description
 (Optional) Whether the markup implementation should convert newlines to breaks. By default this is false which reflects the standard markdown specification.
 - Optional ReadonlyhtmlEscape?: string
 Description
 (Optional) true if HTML should be escaped in the input markup, false otherwise.
 - Optional ReadonlyincludeHeadingId?: string
 Description
 (Optional) true if headers should contain an ID based on the heading content.
 - Optional ReadonlyurlMode?: string
 Description
 (Optional) The mode to use when building URLs. One of: ABSOLUTE, RELATIVE or, CONFIGURED. By default this is RELATIVE.
- Optional ReadonlyrequestBody?: { content: { "*/*": string } }
- Readonlyresponses: { "200": { content: { "application/json": { html?: string } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { html?: string } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The rendered markdown.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The markdown was invalid.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions preview rendered markdown.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/exports`

"/api/latest/migration/exports": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    exportLocation?: string;
                    repositoriesRequest: {
                        includes: readonly { projectKey?: string; slug?: string }[];
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        endDate?: number;
                        id?: number;
                        initiator?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        nodeId?: string;
                        progress?: { message?: string; percentage?: number };
                        startDate?: number;
                        state?:
                            | "FAILED"
                            | "COMPLETED"
                            | "RUNNING"
                            | "READY"
                            | "INITIALISING"
                            | "ABORTED"
                            | "CANCELED"
                            | "CANCELING"
                            | "FINALISING"
                            | "TIMED_OUT";
                        type?: string;
                        updatedDate?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "503": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { exportLocation?: string; repositoriesRequest: { includes: readonly { projectKey?: string; slug?: string }[]; }; }; }; }; responses: { "200": { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "503": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Start export job
Description
Starts a background job that exports the selected repositories.
Only 2 concurrent exports are supported _per cluster node_. If a request ends up on a node that is already running that many export jobs, the request will be rejected and an error returned. The response includes a description of the job that has been started, and its ID can be used to query these details again, including the current progress, warnings and errors that occurred while processing the job, and to interrupt and cancel the execution of this job. The request to start an export is similar to the one for previewing an export. Additionally, it accepts an optional parameter, `exportLocation`, which can be used to specify a _relative_ path within `data/migration/export` in the shared home directory. No locations outside of that directory will be accepted for exports. There are essentially three ways to select repositories for export. Regardless of which you use, a few general rules apply: - You can supply a list of selectors. The selection will be additive. - Repositories that are selected more than once due to overlapping selectors will be de-duplicated and effectively exported only once. - For every selected repository, its full fork hierarchy will be considered selected, even if parts of that hierarchy would otherwise not be matched by the provided selectors. For example, when you explicitly select a single repository only, but that repository is a fork, then its origin will be exported (and eventually imported), too. Now, a single repository can be selected like this: ``` { "projectKey": "PRJ", "slug": "my-repo" } ``` Second, all repositories in a specific project can be selected like this: ``` { "projectKey": "PRJ", "slug": *" } ``` And third, all projects and repositories in the system would be selected like this: ``` { "projectKey": "*", "slug": *" } ``` The authenticated user must have **ADMIN** permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { exportLocation?: string; repositoriesRequest: { includes: readonly { projectKey?: string; slug?: string }[]; }; }; }; }
 Description
 The request
- Readonlyresponses: { "200": { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "503": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Details about the export job.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to start anexport
 - Readonly503: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The export could not be started because the limit of concurrent migration jobs has been reached.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/exports/{jobId}`

"/api/latest/migration/exports/{jobId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { jobId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        endDate?: number;
                        id?: number;
                        initiator?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        nodeId?: string;
                        progress?: { message?: string; percentage?: number };
                        startDate?: number;
                        state?:
                            | "FAILED"
                            | "COMPLETED"
                            | "RUNNING"
                            | "READY"
                            | "INITIALISING"
                            | "ABORTED"
                            | "CANCELED"
                            | "CANCELING"
                            | "FINALISING"
                            | "TIMED_OUT";
                        type?: string;
                        updatedDate?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get export job details
Description
Gets the details, including the current status and progress, of the export job identified by the given ID.
The authenticated user must have **ADMIN** permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { jobId: string }
 - ReadonlyjobId: string
 Description
 the ID of the job
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The job, including status and progress information.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve information about this job.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified job does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/exports/{jobId}/cancel`

"/api/latest/migration/exports/{jobId}/cancel": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { jobId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Cancel export job
Description
Requests the cancellation of an export job.
The request to cancel a job will be processed successfully if the job is actually still running. If it has already finished (successfully or with errors) or if it has already been canceled before, then an error will be returned. There might be a small delay between accepting the request and actually cancelling the job. In most cases, the delay will be close to instantaneously. In the unlikely case of communication issues across a cluster, it can however take a few seconds to cancel a job. A client should always actively query the job status to confirm that a job has been successfully canceled. The authenticated user must have **ADMIN** permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { jobId: string }
 - ReadonlyjobId: string
 Description
 the ID of the job to cancel
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The job has successfully been marked for cancellation
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to cancel this job.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified job does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The job was in a state that does not allow cancellation, e.g. it has already finished.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/exports/{jobId}/messages`

"/api/latest/migration/exports/{jobId}/messages": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { jobId: string };
            query?: {
                limit?: number;
                severity?: string;
                start?: number;
                subject?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            createdDate?: string;
                            id?: string;
                            severity?: "ERROR"
                            | "INFO"
                            | "WARN";
                            subject?: string;
                            text?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: { limit?: number; severity?: string; start?: number; subject?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: string; id?: string; severity?: "ERROR" | "INFO" | "WARN"; subject?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get job messages
Description
Gets the messages generated by the job.
Without any filter, all messages will be returned, but the response can optionally be filtered for the following severities. The severity parameter can be repeated to include multiple severities in one response. - INFO - WARN - ERROR The authenticated user must have **ADMIN** permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: { limit?: number; severity?: string; start?: number; subject?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { jobId: string }
 - ReadonlyjobId: string
 Description
 The ID of the job
 - Optional Readonlyquery?: { limit?: number; severity?: string; start?: number; subject?: string }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyseverity?: string
 Description
 The severity to include in the results
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlysubject?: string
 Description
 The subject
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: string; id?: string; severity?: "ERROR" | "INFO" | "WARN"; subject?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: string; id?: string; severity?: "ERROR" | "INFO" | "WARN"; subject?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The messages generated by this job.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve information about this job.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified job does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/exports/preview`

"/api/latest/migration/exports/preview": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    exportLocation?: string;
                    repositoriesRequest: {
                        includes: readonly { projectKey?: string; slug?: string }[];
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        links?: Record<string, unknown>;
                        scopes?: readonly Record<string, unknown>[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { exportLocation?: string; repositoriesRequest: { includes: readonly { projectKey?: string; slug?: string }[]; }; }; }; }; responses: { "200": { content: { "application/json": { links?: Record<string, unknown>; scopes?: readonly Record<string, unknown>[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Preview export
Description
Enumerates the projects and repositories that would be exported for a given export request.
All affected repositories will be enumerated explicitly, and while projects are listed as individual items in responses from this endpoint, their presence does not imply that all their repositories are included. While this endpoint can be used to verify that all selectors in the request apply as intended, it should be noted that a subsequent, actual export might contain a different set of repositories, as they might have been added or deleted in the meantime. Note that the overall response from this endpoint can become very large when a lot of repositories end up in the selection. This is why the server is streaming the response while it is being generated (as opposed to creating it in memory and then sending it all at once) and it can be consumed in a streaming way, too. Also, due to the potential size of the response, projects and repositories are listed with fewer details than in other REST responses. For a more detailed description of selectors, see the endpoint documentation for starting an export. The authenticated user must have **ADMIN** permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { exportLocation?: string; repositoriesRequest: { includes: readonly { projectKey?: string; slug?: string }[]; }; }; }; }
 Description
 the export request
- Readonlyresponses: { "200": { content: { "application/json": { links?: Record<string, unknown>; scopes?: readonly Record<string, unknown>[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { links?: Record<string, unknown>; scopes?: readonly Record<string, unknown>[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The effectively selected projects and repositories.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to generate a preview.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/imports`

"/api/latest/migration/imports": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: { "application/json": { archivePath?: string } };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        endDate?: number;
                        id?: number;
                        initiator?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        nodeId?: string;
                        progress?: { message?: string; percentage?: number };
                        startDate?: number;
                        state?:
                            | "FAILED"
                            | "COMPLETED"
                            | "RUNNING"
                            | "READY"
                            | "INITIALISING"
                            | "ABORTED"
                            | "CANCELED"
                            | "CANCELING"
                            | "FINALISING"
                            | "TIMED_OUT";
                        type?: string;
                        updatedDate?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "503": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { archivePath?: string } } }; responses: { "200": { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "503": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Start import job
Description
Starts a background job that imports the specified archive.
Only 1 import at a time is supported _per cluster_. If another request is made while an import is already running, the request will be rejected and an error returned. The path in the request must point to a valid archive file. The file must be located within the `data/migration/import` directory in the shared home directory. The authenticated user must have **ADMIN** permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { archivePath?: string } } }
 Description
 The request
- Readonlyresponses: { "200": { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "503": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Details about the export job.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to start an import.
 - Readonly503: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The import could not be started because the limit of concurrent migration jobs has been reached.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/imports/{jobId}`

"/api/latest/migration/imports/{jobId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { jobId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        endDate?: number;
                        id?: number;
                        initiator?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        nodeId?: string;
                        progress?: { message?: string; percentage?: number };
                        startDate?: number;
                        state?:
                            | "FAILED"
                            | "COMPLETED"
                            | "RUNNING"
                            | "READY"
                            | "INITIALISING"
                            | "ABORTED"
                            | "CANCELED"
                            | "CANCELING"
                            | "FINALISING"
                            | "TIMED_OUT";
                        type?: string;
                        updatedDate?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get import job status
Description
Gets the details, including the current status and progress, of the import job identified by the given ID.
The authenticated user must have **ADMIN** permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { jobId: string }
 - ReadonlyjobId: string
 Description
 The ID of the job
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The job, including status and progress information.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve information about this job.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified job does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/imports/{jobId}/cancel`

"/api/latest/migration/imports/{jobId}/cancel": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { jobId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Cancel import job
Description
Requests the cancellation of an import job.
The request to cancel a job will be processed successfully if the job is actually still running. If it has already finished (successfully or with errors) or if it has already been canceled before, then an error will be returned. Note that import jobs are not canceled as instantaneously as export jobs. Rather, once the request has been accepted, there are a number of checkpoints at which the job will actually apply it and stop. This is to keep the system in a reasonably consistent state: - After the current fork hierarchy has been imported and verified. - Before the next repository is imported. - Before the next pull request is imported. A client should always actively query the job status to confirm that a job has been successfully canceled. The authenticated user must have **ADMIN** permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { jobId: string }
 - ReadonlyjobId: string
 Description
 the ID of the job to cancel
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The job has successfully been marked for cancellation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to cancel this job.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified job does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The job was in a state that does not allow cancellation, e.g. it has already finished.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/imports/{jobId}/messages`

"/api/latest/migration/imports/{jobId}/messages": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { jobId: string };
            query?: {
                limit?: number;
                severity?: string;
                start?: number;
                subject?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            createdDate?: string;
                            id?: string;
                            severity?: "ERROR"
                            | "INFO"
                            | "WARN";
                            subject?: string;
                            text?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: { limit?: number; severity?: string; start?: number; subject?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: string; id?: string; severity?: "ERROR" | "INFO" | "WARN"; subject?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get import job messages
Description
Gets the messages generated by the job.
Without any filter, all messages will be returned, but the response can optionally be filtered for the following severities. The severity parameter can be repeated to include multiple severities in one response. - INFO - WARN - ERROR The authenticated user must have **ADMIN** permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: { limit?: number; severity?: string; start?: number; subject?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { jobId: string }
 - ReadonlyjobId: string
 Description
 The ID of the job
 - Optional Readonlyquery?: { limit?: number; severity?: string; start?: number; subject?: string }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyseverity?: string
 Description
 The severity to include in the results
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlysubject?: string
 Description
 The subject
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: string; id?: string; severity?: "ERROR" | "INFO" | "WARN"; subject?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: string; id?: string; severity?: "ERROR" | "INFO" | "WARN"; subject?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The messages generated by this job.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve information about this job.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified job does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/mesh`

"/api/latest/migration/mesh": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    all?: boolean;
                    maxBytesPerSecond?: { asLong?: number; present?: boolean };
                    projectIds?: readonly number[];
                    repositoryIds?: readonly number[];
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        endDate?: number;
                        id?: number;
                        initiator?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        nodeId?: string;
                        progress?: { message?: string; percentage?: number };
                        startDate?: number;
                        state?:
                            | "FAILED"
                            | "COMPLETED"
                            | "RUNNING"
                            | "READY"
                            | "INITIALISING"
                            | "ABORTED"
                            | "CANCELED"
                            | "CANCELING"
                            | "FINALISING"
                            | "TIMED_OUT";
                        type?: string;
                        updatedDate?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "503": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { all?: boolean; maxBytesPerSecond?: { asLong?: number; present?: boolean }; projectIds?: readonly number[]; repositoryIds?: readonly number[]; }; }; }; responses: { "200": { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "503": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Start Mesh migration job
Description
Starts a background job that migrates selected projects/repositories to Mesh.
Only 1 job is supported _per cluster_. The response includes a description of the job that has been started, and its ID can be used to query these details again, including the current progress, and to interrupt and cancel the execution of this job. The request to start a migration is similar to the one for previewing a migration. There are essentially three ways to select repositories for migration. Regardless of which you use, a few general rules apply: - You can supply a list of repository IDs and project IDs. The selection will be additive. All repositories in the system are migrated if both lists are empty. - Repositories that are selected more than once due to overlapping IDs will be de-duplicated and effectively migrated only once. - For every selected repository, its full fork hierarchy will be considered selected, even if parts of that hierarchy would otherwise not be matched by the provided IDs. For example, when you explicitly select a single repository only, but that repository is a fork, then its origin will be migrated too. Now, a single repository can be selected like this: ``` { "repositoryIds": [1] } ``` Multiple repositories can be selected like this: ``` { "repositoryIds": [1, 2] } ``` Second, all repositories in a specific project can be selected like this: ``` { "projectIds": [1] } ``` And third, all projects and repositories in the system would be selected like this: ``` { "projectIds": [], "repositoryIds": [] } ``` The authenticated user must have **SYS_ADMIN** permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { all?: boolean; maxBytesPerSecond?: { asLong?: number; present?: boolean }; projectIds?: readonly number[]; repositoryIds?: readonly number[]; }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "503": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { endDate?: number; id?: number; initiator?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; nodeId?: string; progress?: { message?: string; percentage?: number }; startDate?: number; state?: | "FAILED" | "COMPLETED" | "RUNNING" | "READY" | "INITIALISING" | "ABORTED" | "CANCELED" | "CANCELING" | "FINALISING" | "TIMED_OUT"; type?: string; updatedDate?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The started job
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The migration request failed one/more validation checks.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly503: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A migration job is already in progress
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/mesh/{jobId}`

"/api/latest/migration/mesh/{jobId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { jobId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get Mesh migration job details
Description
Gets the details, including the current status and progress, of the job identified by the given ID.
The authenticated user must have **SYS_ADMIN** permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { jobId: string }
 - ReadonlyjobId: string
 Description
 The ID of the job
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The details of the migration job.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The job ID parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified job ID does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/mesh/{jobId}/cancel`

"/api/latest/migration/mesh/{jobId}/cancel": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { jobId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Cancel Mesh migration job
Description
Requests the cancellation of a migration job.
The request to cancel a job will be processed successfully if the job is actually still running. If it has already finished (successfully or with errors) or if it has already been canceled before, then an error will be returned. There might be a small delay between accepting the request and actually cancelling the job. In most cases, the delay will be close to instantaneously. In the unlikely case of communication issues across a cluster, it can however take a few seconds to cancel a job. A client should always actively query the job status to confirm that a job has been successfully canceled. The authenticated user must have **SYS_ADMIN** permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { jobId: string }
 - ReadonlyjobId: string
 Description
 The ID of the job to cancel
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The migration job was successfully marked for cancellation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified job ID does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The migration job has already been canceled or finished.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/mesh/{jobId}/messages`

"/api/latest/migration/mesh/{jobId}/messages": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { jobId: string };
            query?: {
                limit?: number;
                severity?: string;
                start?: number;
                subject?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            createdDate?: string;
                            id?: string;
                            severity?: "ERROR"
                            | "INFO"
                            | "WARN";
                            subject?: string;
                            text?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: { limit?: number; severity?: string; start?: number; subject?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: string; id?: string; severity?: "ERROR" | "INFO" | "WARN"; subject?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get Mesh migration job messages
Description
Gets the messages generated by the job.
Without any filter, all messages will be returned, but the response can optionally be filtered for the following severities. The severity parameter can be repeated to include multiple severities in one response. - INFO - WARN - ERROR The authenticated user must have **SYS_ADMIN** permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: { limit?: number; severity?: string; start?: number; subject?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { jobId: string }
 - ReadonlyjobId: string
 Description
 The ID of the job
 - Optional Readonlyquery?: { limit?: number; severity?: string; start?: number; subject?: string }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyseverity?: string
 Description
 The severity to include in the results
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlysubject?: string
 Description
 The subject
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: string; id?: string; severity?: "ERROR" | "INFO" | "WARN"; subject?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: string; id?: string; severity?: "ERROR" | "INFO" | "WARN"; subject?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The details of the migration job.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The job ID parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified job ID does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/mesh/{jobId}/summary`

"/api/latest/migration/mesh/{jobId}/summary": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { jobId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        endTime?: number;
                        jobId?: number;
                        maxBandwidth?: number;
                        progress?: number;
                        queue?: Record<string, unknown>;
                        startTime?: number;
                        state?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { endTime?: number; jobId?: number; maxBandwidth?: number; progress?: number; queue?: Record<string, unknown>; startTime?: number; state?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get Mesh migration job summary
Description
Gets the summary, including the queue status and progress, of a Mesh migration job.
The authenticated user must have **SYS_ADMIN** permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { jobId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { jobId: string }
 - ReadonlyjobId: string
 Description
 The ID of the job
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { endTime?: number; jobId?: number; maxBandwidth?: number; progress?: number; queue?: Record<string, unknown>; startTime?: number; state?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { endTime?: number; jobId?: number; maxBandwidth?: number; progress?: number; queue?: Record<string, unknown>; startTime?: number; state?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The summary of the migration job.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The job ID parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified job ID does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/mesh/preview`

"/api/latest/migration/mesh/preview": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    all?: boolean;
                    maxBytesPerSecond?: { asLong?: number; present?: boolean };
                    projectIds?: readonly number[];
                    repositoryIds?: readonly number[];
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        repositories?: readonly {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            origin?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            partition?: number;
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            public?: boolean;
                            relatedLinks?: Record<(...), (...)>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { all?: boolean; maxBytesPerSecond?: { asLong?: number; present?: boolean }; projectIds?: readonly number[]; repositoryIds?: readonly number[]; }; }; }; responses: { "200": { content: { "application/json": { repositories?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Preview Mesh migration
Description
Enumerates the projects and repositories that would be migrated for a given request.
All affected repositories will be enumerated explicitly, and while projects are listed as individual items in responses from this endpoint, their presence does not imply that all their repositories are included. While this endpoint can be used to verify that all selectors in the request apply as intended, it should be noted that a subsequent, actual export might contain a different set of repositories, as they might have been added or deleted in the meantime. Note that the overall response from this endpoint can become very large when a lot of repositories end up in the selection. This is why the server is streaming the response while it is being generated (as opposed to creating it in memory and then sending it all at once) and it can be consumed in a streaming way, too. Also, due to the potential size of the response, projects and repositories are listed with fewer details than in other REST responses. The authenticated user must have **SYS_ADMIN** permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { all?: boolean; maxBytesPerSecond?: { asLong?: number; present?: boolean }; projectIds?: readonly number[]; repositoryIds?: readonly number[]; }; }; }
 Description
 The export request
- Readonlyresponses: { "200": { content: { "application/json": { repositories?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { repositories?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Enumeration of projects and repositories that would be migrated for a given request.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was invalid or missing.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/mesh/repos`

"/api/latest/migration/mesh/repos": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: number;
                migrationId?: string;
                name?: string;
                projectKey?: string;
                remote?: string;
                start?: number;
                state?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            migrationState?: | "FAILED"
                            | "SKIPPED"
                            | "CANCELED"
                            | "MIGRATED"
                            | "QUEUED"
                            | "STAGED"
                            | "STAGING";
                            repository?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                origin?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; migrationId?: string; name?: string; projectKey?: string; remote?: string; start?: number; state?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { migrationState?: | "FAILED" | "SKIPPED" | "CANCELED" | "MIGRATED" | "QUEUED" | "STAGED" | "STAGING"; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find repositories by Mesh migration state
Description
Searches for repositories in the system matching the specified criteria and enriches their MeshMigrationQueueState migration state if a migration is currently in progress.
The currently active migration can optionally be specified by passing a migrationId, if known. If this isn't passed, an attempt is made to locate the active migration and its ID is used. If a migration is currently active, only repositories that are a part of the migration are filtered and returned. Otherwise, all repositories in the systems are filtered and returned. Filtering by state is ignored when no migration is currently in progress. In such a case, results are not enriched with their MeshMigrationQueueState migration state. The authenticated user must have **SYS_ADMIN** permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; migrationId?: string; name?: string; projectKey?: string; remote?: string; start?: number; state?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; migrationId?: string; name?: string; projectKey?: string; remote?: string; start?: number; state?: string; }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional ReadonlymigrationId?: string
 Description
 (optional) The currently active migration job. If not passed, this is looked up internally.
 - Optional Readonlyname?: string
 Description
 (optional) The repository name
 - Optional ReadonlyprojectKey?: string
 Description
 (optional) The project key. Can be specified more than once to filter by more than one project.
 - Optional Readonlyremote?: string
 Description
 (optional) Whether the repository has been fully migrated to Mesh. If not present, all repositories are considered regardless of where they're located.
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlystate?: string
 Description
 (optional) If a migration is active, the MeshMigrationQueueState state to filter results by. Can be specified more than once to filter by more than one state.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { migrationState?: | "FAILED" | "SKIPPED" | "CANCELED" | "MIGRATED" | "QUEUED" | "STAGED" | "STAGING"; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { migrationState?: | "FAILED" | "SKIPPED" | "CANCELED" | "MIGRATED" | "QUEUED" | "STAGED" | "STAGING"; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of repositories matching the specified criteria.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No migration job with the given ID exists.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/mesh/summaries`

"/api/latest/migration/mesh/summaries": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            endTime?: number;
                            jobId?: number;
                            maxBandwidth?: number;
                            progress?: number;
                            queue?: Record<(...), (...)>;
                            startTime?: number;
                            state?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { endTime?: number; jobId?: number; maxBandwidth?: number; progress?: number; queue?: Record<(...), (...)>; startTime?: number; state?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all Mesh migration job summaries
Description
Retrieve a page of Mesh migration job summaries. Jobs are ordered by when they were started, newest first.
The authenticated user must have **SYS_ADMIN** permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { endTime?: number; jobId?: number; maxBandwidth?: number; progress?: number; queue?: Record<(...), (...)>; startTime?: number; state?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { endTime?: number; jobId?: number; maxBandwidth?: number; progress?: number; queue?: Record<(...), (...)>; startTime?: number; state?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The summary of the migration job.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/migration/mesh/summary`

"/api/latest/migration/mesh/summary": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        endTime?: number;
                        jobId?: number;
                        maxBandwidth?: number;
                        progress?: number;
                        queue?: Record<string, unknown>;
                        startTime?: number;
                        state?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { endTime?: number; jobId?: number; maxBandwidth?: number; progress?: number; queue?: Record<string, unknown>; startTime?: number; state?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get summary for Mesh migration job
Description
Gets the summary, including the queue status and progress, of the currently active Mesh migration job.
The authenticated user must have **SYS_ADMIN** permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { endTime?: number; jobId?: number; maxBandwidth?: number; progress?: number; queue?: Record<string, unknown>; startTime?: number; state?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { endTime?: number; jobId?: number; maxBandwidth?: number; progress?: number; queue?: Record<string, unknown>; startTime?: number; state?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The summary of the currently active migration job.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No active migration job found.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/profile/recent/repos`

"/api/latest/profile/recent/repos": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { limit?: number; permission?: string; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            origin?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            partition?: number;
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            public?: boolean;
                            relatedLinks?: Record<(...), (...)>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; permission?: string; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get recently accessed repositories
Description
Retrieve a page of recently accessed repositories for the currently authenticated user.
Repositories are ordered from most recently to least recently accessed. Only authenticated users may call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; permission?: string; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; permission?: string; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlypermission?: string
 Description
 (optional) If specified, it must be a valid repository permission level name and will limit the resulting repository list to ones that the requesting user has the specified permission level to. If not specified, the default REPO_READ permission level will be assumed.
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of recently accessed repositories.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The permission level is unknown or not related to repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request is unauthenticated.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects`

"/api/latest/projects": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: number;
                name?: string;
                permission?: string;
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key?: string;
                            links?: Record<(...), (...)>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    avatar?: string;
                    avatarUrl?: string;
                    description?: string;
                    id?: number;
                    key?: string;
                    links?: Record<string, unknown>;
                    name?: string;
                    public?: boolean;
                    scope?: string;
                    type?: "NORMAL" | "PERSONAL";
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key?: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; name?: string; permission?: string; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<(...), (...)>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get projects
Description
Retrieve a page of projects.
Only projects for which the authenticated user has the PROJECT_VIEW permission will be returned.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; name?: string; permission?: string; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; name?: string; permission?: string; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyname?: string
 Description
 Name to filter by.
 - Optional Readonlypermission?: string
 Description
 Permission to filter by
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<(...), (...)>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<(...), (...)>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of projects.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The permission level is unknown or not related to projects.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; }; responses: { "201": { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create a new project
Description
Create a new project.
To include a custom avatar for the project, the project definition should contain an additional attribute with the key <code>avatar</code> and the value a data URI containing Base64-encoded image data. The URI should be in the following format: <pre> data:(content type, e.g. image/png);base64,(data) </pre>If the data is not Base64-encoded, or if a character set is defined in the URI, or the URI is otherwise invalid, project creation will fail. The authenticated user must have PROJECT_CREATE permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; }
 Description
 The project.
- Readonlyresponses: { "201": { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created project.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update the project.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create a project.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project key or name is already in use.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}`

"/api/latest/projects/{projectKey}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key?: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    avatar?: string;
                    avatarUrl?: string;
                    description?: string;
                    id?: number;
                    key?: string;
                    links?: Record<string, unknown>;
                    name?: string;
                    public?: boolean;
                    scope?: string;
                    type?: "NORMAL" | "PERSONAL";
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key?: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "201": {
                content: {
                    "application/json": {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key?: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete project
Description
Delete the project matching the supplied projectKey.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The project matching the supplied projectKey was deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project can not be deleted as it contains repositories.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a project
Description
Retrieve the project matching the supplied projectKey.
The authenticated user must have PROJECT_VIEW permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project matching the supplied projectKey.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; }; responses: { "200": { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }; "201": { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update project
Description
Update the project matching the projectKey supplied in the resource path.
To include a custom avatar for the updated project, the project definition should contain an additional attribute with the key <code>avatar</code> and the value a data URI containing Base64-encoded image data. The URI should be in the following format: ``` data:(content type, e.g. image/png);base64,(data)``` If the data is not Base64-encoded, or if a character set is defined in the URI, or the URI is otherwise invalid, project creation will fail. The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; }
 Description
 Project parameters to update.
- Readonlyresponses: { "200": { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }; "201": { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated project. The project's key was not updated.
 - Readonly201: { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated project. The project's key was updated.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project was not updated due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/avatar.png`

"/api/latest/projects/{projectKey}/avatar.png": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { s?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: { content: { "multipart/form-data": { avatar?: string } } };
        responses: {
            "201": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { s?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get avatar for project
Description
Retrieve the avatar for the project matching the supplied projectKey.
The authenticated user must have PROJECT_VIEW permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { s?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { s?: string }
 - Optional Readonlys?: string
 Description
 The desired size of the image. The server will return an image as close as possible to the specified size.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The avatar of the project matching the supplied projectKey.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: { content: { "multipart/form-data": { avatar?: string } } }; responses: { "201": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update project avatar
Description
Update the avatar for the project matching the supplied projectKey.
This resource accepts POST multipart form data, containing a single image in a form-field named 'avatar'. There are configurable server limits on both the dimensions (1024x1024 pixels by default) and uploaded file size (1MB by default). Several different image formats are supported, but PNG and JPEG are preferred due to the file size limit. This resource has Cross-Site Request Forgery (XSRF) protection. To allow the request to pass the XSRF check the caller needs to send an <code>X-Atlassian-Token</code> HTTP header with the value <code>no-check</code>. An example <a href="http://curl.haxx.se/">curl</a> request to upload an image name 'avatar.png' would be: ```curl -X POST -u username:password -H "X-Atlassian-Token: no-check" http://example.com/rest/api/1.0/projects/STASH/avatar.png -F avatar=@avatar.png ``` The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "multipart/form-data": { avatar?: string } } }
 Description
 The mutlipart form data containing the file.
- Readonlyresponses: { "201": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The avatar was uploaded successfully.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/hook-scripts`

"/api/latest/projects/{projectKey}/hook-scripts": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            scope?: { resourceId?: ...; type?: ... };
                            script?: {
                                createdDate?: ...;
                                description?: ...;
                                id?: ...;
                                name?: ...;
                                pluginKey?: ...;
                                type?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            };
                            triggerIds?: readonly (...)[];
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { scope?: { resourceId?: ...; type?: ... }; script?: { createdDate?: ...; description?: ...; id?: ...; name?: ...; pluginKey?: ...; type?: ...; updatedDate?: ...; version?: ...; }; triggerIds?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get configured hook scripts
Description
Return a page of hook scripts configured for the specified project.
This endpoint requires **PROJECT_ADMIN** permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { scope?: { resourceId?: ...; type?: ... }; script?: { createdDate?: ...; description?: ...; id?: ...; name?: ...; pluginKey?: ...; type?: ...; updatedDate?: ...; version?: ...; }; triggerIds?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { scope?: { resourceId?: ...; type?: ... }; script?: { createdDate?: ...; description?: ...; id?: ...; name?: ...; pluginKey?: ...; type?: ...; updatedDate?: ...; version?: ...; }; triggerIds?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of hook scripts.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/hook-scripts/{scriptId}`

"/api/latest/projects/{projectKey}/hook-scripts/{scriptId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; scriptId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; scriptId: string };
            query?: undefined;
        };
        requestBody?: {
            content: { "application/json": { triggerIds?: readonly string[] } };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        script?: {
                            createdDate?: string;
                            description?: string;
                            id?: number;
                            name?: string;
                            pluginKey?: string;
                            type?: "POST"
                            | "PRE";
                            updatedDate?: string;
                            version?: number;
                        };
                        triggerIds?: readonly string[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; scriptId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Remove a hook script
Description
Removes the hook script from the set of hook scripts configured to run in all repositories under the project.
This endpoint requires **PROJECT_ADMIN** permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; scriptId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; scriptId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyscriptId: string
 Description
 The ID of the hook script
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The hook script was successfully deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project key or hook script ID supplied does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; scriptId: string }; query?: undefined; }; requestBody?: { content: { "application/json": { triggerIds?: readonly string[] } }; }; responses: { "200": { content: { "application/json": { scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; script?: { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; triggerIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create/update a hook script
Description
Creates/updates the hook script configuration for the provided hook script and project.
This endpoint requires **PROJECT_ADMIN** permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; scriptId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; scriptId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyscriptId: string
 Description
 The ID of the hook script
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { triggerIds?: readonly string[] } } }
 Description
 The hook triggers for which the hook script should be run
- Readonlyresponses: { "200": { content: { "application/json": { scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; script?: { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; triggerIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; script?: { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; triggerIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated hook script.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The hook script was not created/updated due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project key supplied does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/permissions`

"/api/latest/projects/{projectKey}/permissions": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { group?: string; user?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { group?: string; user?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Revoke project permissions
Description
Revoke all permissions for the specified project for the given groups and users.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource. In addition, a user may not revoke a group's permission if their own permission would be revoked as a result, nor may they revoke their own permission unless they have a global permission that already implies that permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { group?: string; user?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { group?: string; user?: string }
 - Optional Readonlygroup?: string
 Description
 The names of the groups
 - Optional Readonlyuser?: string
 Description
 The names of the users
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 All project permissions were revoked from the users and groups for the specified project.
 - Readonly400: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 No permissions were revoked because the request was invalid. No users or groups were provided.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not an administrator for the specifiedspecified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist, or one or more of the users or groups provided does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would revoke the currently authenticated user's permission on the project.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/permissions/{permission}/all`

"/api/latest/projects/{projectKey}/permissions/{permission}/all": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { permission: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { permitted?: boolean } };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { permission: string; projectKey: string };
            query?: { allow?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { permission: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { permitted?: boolean } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Check default project permission
Description
Check whether the specified permission is the default permission (granted to all users) for a project.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { permission: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { permission: string; projectKey: string }
 - Readonlypermission: string
 Description
 The permission to grant. Available project permissions are:
 - PROJECT_READ - PROJECT_WRITE - PROJECT_ADMIN
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { permitted?: boolean } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { permitted?: boolean } }; headers: Readonly<Record<string, unknown>>; }
 Description
 A simple entity indicating whether the specified permission is the defaultpermission for this project.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed or the specified permission does not exist.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not an administrator for the specifiedspecified project.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would reduce the currently authenticated user'spermission level.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { permission: string; projectKey: string }; query?: { allow?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Grant project permission
Description
Grant or revoke a project permission to all users, i.e. set the default permission.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { permission: string; projectKey: string }; query?: { allow?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { permission: string; projectKey: string }
 - Readonlypermission: string
 Description
 The permission to grant. Available project permissions are:
 - PROJECT_READ - PROJECT_WRITE - PROJECT_ADMIN
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { allow?: string }
 - Optional Readonlyallow?: string
 Description
 true to grant the specified permission to all users, or false to revoke it
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The requested permission was successfully granted or revoked.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed or the specified permission does not exist.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not an administrator for the specified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/permissions/groups`

"/api/latest/projects/{projectKey}/permissions/groups": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { name?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { filter?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly { group?: { name?: ... }; permission?: string }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { name?: string; permission?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { name?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Revoke group project permission
Description
Revoke all permissions for the specified project for a group.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource. In addition, a user may not revoke a group's permissions if it will reduce their own permission level.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { name?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { name?: string }
 - Optional Readonlyname?: string
 Description
 The name of the group
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 All project permissions were revoked from the group for the specified project.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not an administrator for the specifiedspecified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would reduce the currently authenticated user'spermission level.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { group?: { name?: ... }; permission?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get groups with permission to project
Description
Retrieve a page of groups that have been granted at least one permission for the specified project.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only group names containing the supplied string will be returned
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { group?: { name?: ... }; permission?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { group?: { name?: ... }; permission?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of groups and their highest permissions for the specified project.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a project administrator for the specified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { name?: string; permission?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update group project permission
Description
Promote or demote a group's permission level for the specified project.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource. In addition, a user may not demote a group's permission level if theirown permission level would be reduced as a result.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { name?: string; permission?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { name?: string; permission?: string }
 - Optional Readonlyname?: string
 Description
 The names of the groups
 - Optional Readonlypermission?: string
 Description
 The permission to grant.See the permissions documentationfor a detailed explanation of what each permission entails. Available project permissions are:
 - PROJECT_READ - PROJECT_WRITE - PROJECT_ADMIN
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The requested permission was granted.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed or the specified permission does not exist.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not an administrator for the specifiedspecified project.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would reduce the currently authenticated user'spermission level.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/permissions/groups/none`

"/api/latest/projects/{projectKey}/permissions/groups/none": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { filter?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "202": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly { deletable?: boolean; name?: string }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "202": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { deletable?: boolean; name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get groups without project permission
Description
Retrieve a page of groups that have no granted permissions for the specified project.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only group names containing the supplied string will be returned
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "202": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { deletable?: boolean; name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly202: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { deletable?: boolean; name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of groups that have not been granted any permissions for the specifiedproject.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a project administrator for thespecified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/permissions/search`

"/api/latest/projects/{projectKey}/permissions/search": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { filterText?: string; permission?: string; type?: string };
        };
        requestBody?: undefined;
        responses: {
            default: {
                content: { "application/json;charset=UTF-8": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filterText?: string; permission?: string; type?: string }; }; requestBody?: undefined; responses: { default: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }; }; }
Search project permissions
Description
Search direct and implied permissions of principals (users and groups). This endpoint returns a superset of the results returned by the /users and /groups endpoints because it allows filtering by global permissions too.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filterText?: string; permission?: string; type?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { filterText?: string; permission?: string; type?: string }
 - Optional ReadonlyfilterText?: string
 Description
 Name of the user or group to filter the name of
 - Optional Readonlypermission?: string
 Description
 Permissions to filter by. See the permissions documentationfor a detailed explanation of what each permission entails. This parameter can be specified multiple times to filter by more than one permission, and can contain global and project permissions.
 - Optional Readonlytype?: string
 Description
 Type of entity (user or group)Valid entity types are:
 - USER- GROUP
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { default: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonlydefault: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 default response
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/permissions/users`

"/api/latest/projects/{projectKey}/permissions/users": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { name?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { filter?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            permission?: | "ADMIN"
                            | "LICENSED_USER"
                            | "PROJECT_ADMIN"
                            | "PROJECT_CREATE"
                            | "PROJECT_READ"
                            | "PROJECT_VIEW"
                            | "PROJECT_WRITE"
                            | "REPO_ADMIN"
                            | "REPO_CREATE"
                            | "REPO_READ"
                            | "REPO_WRITE"
                            | "SYS_ADMIN"
                            | "USER_ADMIN";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { name?: string; permission?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { name?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Revoke user project permission
Description
Revoke all permissions for the specified project for a user.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource. In addition, a user may not revoke their own project permissions if they do not have a higher global permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { name?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { name?: string }
 - Optional Readonlyname?: string
 Description
 The name of the user
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 All project permissions were revoked from the user for the specified project.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not an administrator for the specifiedspecified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would reduce the currently authenticated user'spermission level.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get users with permission to project
Description
Retrieve a page of users that have been granted at least one permission for the specified project.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only user names containing the supplied string will be returned
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of users and their highest permissions for the specified project.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a project administrator for thespecified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { name?: string; permission?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update user project permission
Description
Promote or demote a user's permission level for the specified project.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource. In addition, a user may not reduce their own permission level unless they have a global permission that already implies that permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { name?: string; permission?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { name?: string; permission?: string }
 - Optional Readonlyname?: string
 Description
 The names of the users
 - Optional Readonlypermission?: string
 Description
 The permission to grant.See the permissions documentationfor a detailed explanation of what each permission entails. Available project permissions are:
 - PROJECT_READ - PROJECT_WRITE - PROJECT_ADMIN
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The requested permission was granted.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed or the specified permission does not exist.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not an administrator for the specifiedspecified project.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would reduce the currently authenticated user'spermission level.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/permissions/users/none`

"/api/latest/projects/{projectKey}/permissions/users/none": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { filter?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get users without project permission
Description
Retrieve a page of licensed users that have no granted permissions for the specified project.
The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only user names containing the supplied string will be returned
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of users that have not been granted any permissions for the specified project
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a project administrator for thespecified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos`

"/api/latest/projects/{projectKey}/repos": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            origin?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            partition?: number;
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            public?: boolean;
                            relatedLinks?: Record<(...), (...)>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    archived?: boolean;
                    defaultBranch?: string;
                    description?: string;
                    forkable?: boolean;
                    hierarchyId?: string;
                    id?: number;
                    links?: Record<string, unknown>;
                    name?: string;
                    origin?: {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        partition?: number;
                        project?: {
                            avatar?: (...) | (...);
                            avatarUrl?: (...) | (...);
                            description?: (...) | (...);
                            id?: (...) | (...);
                            key: string;
                            links?: (...) | (...);
                            name?: (...) | (...);
                            public?: (...) | (...) | (...);
                            scope?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                    partition?: number;
                    project?: {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                    public?: boolean;
                    relatedLinks?: Record<string, unknown>;
                    scmId?: string;
                    scope?: string;
                    slug?: string;
                    state?:
                        | "AVAILABLE"
                        | "INITIALISATION_FAILED"
                        | "INITIALISING"
                        | "OFFLINE";
                    statusMessage?: string;
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        origin?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            partition?: number;
                            project?: {
                                avatar?: (...) | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                        partition?: number;
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repositories for project
Description
Retrieve repositories from the project corresponding to the supplied projectKey.
The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repositories matching the supplied projectKey.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to see the specified project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; responses: { "201": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create repository
Description
Create a new repository. Requires an existing project in which this repository will be created. The only parameters which will be used are name and scmId.
The authenticated user must have REPO_CREATE permission or higher, for the context project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }
 Description
 The repository
- Readonlyresponses: { "201": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created repository.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository was not created due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create a repository.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A repository with same name already exists.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "202": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "204": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        origin?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            partition?: number;
                            project?: {
                                avatar?: (...) | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                        partition?: number;
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    archived?: boolean;
                    defaultBranch?: string;
                    description?: string;
                    forkable?: boolean;
                    hierarchyId?: string;
                    id?: number;
                    links?: Record<string, unknown>;
                    name?: string;
                    origin?: {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        partition?: number;
                        project?: {
                            avatar?: (...) | (...);
                            avatarUrl?: (...) | (...);
                            description?: (...) | (...);
                            id?: (...) | (...);
                            key: string;
                            links?: (...) | (...);
                            name?: (...) | (...);
                            public?: (...) | (...) | (...);
                            scope?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                    partition?: number;
                    project?: {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                    public?: boolean;
                    relatedLinks?: Record<string, unknown>;
                    scmId?: string;
                    scope?: string;
                    slug?: string;
                    state?:
                        | "AVAILABLE"
                        | "INITIALISATION_FAILED"
                        | "INITIALISING"
                        | "OFFLINE";
                    statusMessage?: string;
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        origin?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            partition?: number;
                            project?: {
                                avatar?: (...) | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                        partition?: number;
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    archived?: boolean;
                    defaultBranch?: string;
                    description?: string;
                    forkable?: boolean;
                    hierarchyId?: string;
                    id?: number;
                    links?: Record<string, unknown>;
                    name?: string;
                    origin?: {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        partition?: number;
                        project?: {
                            avatar?: (...) | (...);
                            avatarUrl?: (...) | (...);
                            description?: (...) | (...);
                            id?: (...) | (...);
                            key: string;
                            links?: (...) | (...);
                            name?: (...) | (...);
                            public?: (...) | (...) | (...);
                            scope?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                    partition?: number;
                    project?: {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                    public?: boolean;
                    relatedLinks?: Record<string, unknown>;
                    scmId?: string;
                    scope?: string;
                    slug?: string;
                    state?:
                        | "AVAILABLE"
                        | "INITIALISATION_FAILED"
                        | "INITIALISING"
                        | "OFFLINE";
                    statusMessage?: string;
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        origin?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            partition?: number;
                            project?: {
                                avatar?: (...) | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                        partition?: number;
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "202": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "204": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete repository
Description
Schedule the repository matching the supplied projectKey and repositorySlug to be deleted.
The authenticated user must have sufficient permissions specified by the repository delete policy to call this resource. The default permission required is REPO_ADMIN permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "202": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "204": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly202: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository has been scheduled for deletion.
 - Readonly204: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No repository matching the supplied projectKey and repositorySlug was found.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the repository.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository
Description
Retrieve the repository matching the supplied projectKey and repositorySlug.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository which matches the supplied projectKey and repositorySlug.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to see the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; responses: { "201": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Fork repository
Description
Create a new repository forked from an existing repository.
The JSON body for this <code>POST</code> is not required to contain any properties. Even the name may be omitted. The following properties will be used, if provided: - <code>"name":"Fork name"</code> - Specifies the forked repository's name - Defaults to the name of the origin repository if not specified - <code>"defaultBranch":"main"</code> - Specifies the forked repository's default branch - Defaults to the origin repository's default branch if not specified - <code>"project":{"key":"TARGET_KEY"}</code> - Specifies the forked repository's target project by key - Defaults to the current user's personal project if not specified The authenticated user must have REPO_READ permission for the specified repository and PROJECT_ADMIN on the target project to call this resource. Note that users always have PROJECT_ADMIN permission on their personal projects.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }
 Description
 The rest fork.
- Readonlyresponses: { "201": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created fork.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A validation error prevented the fork from being created. Possible validation errors include: The name or slug for the fork collides with another repository in the target project; an SCM type was specified in the JSON body; a project was specified in the JSON body without a "key" property.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create a fork.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist, or, if a target project was specified, the target project does not exist.
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; responses: { "201": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update repository
Description
Update the repository matching the repositorySlug supplied in the resource path.
The repository's slug is derived from its name. If the name changes the slug may also change. This resource can be used to change the repository's default branch by specifying a new default branch in the request. For example: <code>"defaultBranch":"main"</code> This resource can be used to move the repository to a different project by specifying a new project in the request. For example: <code>"project":{"key":"NEW_KEY"}</code> The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }
 Description
 The updated repository.
- Readonlyresponses: { "201": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated repository.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository was not updated due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update a repository.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Cannot archive repository because it has open pull requests.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A repository with the same name as the target already exists, or the repository is archived.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/archive`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/archive": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                at?: string;
                filename?: string;
                format?: string;
                path?: string;
                prefix?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; filename?: string; format?: string; path?: string; prefix?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Stream archive of repository
Description
Streams an archive of the repository's contents at the requested commit. If no at= commit is requested, an archive of the default branch is streamed.
The <code>filename=</code> query parameter may be used to specify the exact filename to include in the "Content-Disposition" header. If an explicit filename is not provided, one will be automatically generated based on what is being archived. Its format depends on the at= value: - No <code>at=</code> commit: <slug>-<default-branch-name>@<commit>.<format>; e.g. example-master@43c2f8a0fe8.zip - <code>at=</code>sha: <slug>-<at>.<format>; e.g. example-09bcbb00100cfbb5310fb6834a1d5ce6cac253e9.tar.gz - <code>at=</code>branchOrTag: <slug>-<branchOrTag>@<commit>.<format>; e.g. example-feature@bbb225f16e1.tar - If the branch or tag is qualified (e.g. refs/heads/master, the short name (master) will be included in the filename - If the branch or tag's short name includes slashes (e.g. release/4.6), they will be converted to hyphens in the filename (release-4.5) Archives may be requested in the following formats by adding the <code>format=</code> query parameter: - zip: A zip file using standard compression (Default) - tar: An uncompressed tarball - tar.gz or tgz: A GZip-compressed tarball The contents of the archive may be filtered by using the <code>path=</code> query parameter to specify paths to include. <code>path=</code> may be specified multiple times to include multiple paths. The <code>prefix=</code> query parameter may be used to define a directory (or multiple directories) where the archive's contents should be placed. If the prefix does not end with /, one will be added automatically. The prefix is always treated as a directory; it is not possible to use it to prepend characters to the entries in the archive. Archives of public repositories may be streamed by any authenticated or anonymous user. Streaming archives for non-public repositories requires an authenticated user with at least REPO_READ permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; filename?: string; format?: string; path?: string; prefix?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string; filename?: string; format?: string; path?: string; prefix?: string; }
 - Optional Readonlyat?: string
 Description
 The commit to stream an archive of; if not supplied, an archive of the default branch is streamed
 - Optional Readonlyfilename?: string
 Description
 A filename to include the "Content-Disposition" header
 - Optional Readonlyformat?: string
 Description
 The format to stream the archive in; must be one of: zip, tar, tar.gz or tgz
 - Optional Readonlypath?: string
 Description
 Paths to include in the streamed archive; may be repeated to include multiple paths
 - Optional Readonlyprefix?: string
 Description
 A prefix to apply to all entries in the streamed archive; if the supplied prefix does not end with a trailing /, one will be added automatically
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 An archive or the requested commit, in zip, tar or gzipped-tar format.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested format is not supported.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist or does not contain the at commit.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/attachments/{attachmentId}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/attachments/{attachmentId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                attachmentId: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: { Range?: string; "User-Agent"?: string };
            path: {
                attachmentId: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "206": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { attachmentId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete an attachment
Description
Delete an attachment.
The user must be authenticated and have REPO_ADMIN permission for the specified repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { attachmentId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { attachmentId: string; projectKey: string; repositorySlug: string }
 - ReadonlyattachmentId: string
 Description
 the attachment ID
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the attachment
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The attachment does not exist
Readonlyget: { parameters: { cookie?: undefined; header?: { Range?: string; "User-Agent"?: string }; path: { attachmentId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "206": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get an attachment
Description
Retrieve the attachment.
The authenticated user must have REPO_READ permission for the specified repository that is associated to the attachment. Range requests (see IETF RFC7233) are supported. However only a single range issupported. If multiple ranges are passed the ranges will be ignored and the entire content will be returned in the response.
- Readonlyparameters: { cookie?: undefined; header?: { Range?: string; "User-Agent"?: string }; path: { attachmentId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: { Range?: string; "User-Agent"?: string }
 - Readonlypath: { attachmentId: string; projectKey: string; repositorySlug: string }
 - ReadonlyattachmentId: string
 Description
 the attachment ID
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "206": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 the attachment
 - Readonly206: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 the requested range of bytes from the attachment
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 the user is currently not authenticated
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The attachment does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/attachments/{attachmentId}/metadata`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/attachments/{attachmentId}/metadata": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                attachmentId: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                attachmentId: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": { id?: number; metadata?: string; url?: string };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                attachmentId: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: { content: { "application/json": string } };
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { attachmentId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete attachment metadata
Description
Delete attachment metadata.
The user must be authenticated and have REPO_ADMIN permission for the specified repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { attachmentId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { attachmentId: string; projectKey: string; repositorySlug: string }
 - ReadonlyattachmentId: string
 Description
 the attachment ID
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete theattachment metadata
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The attachment or the attachment metadata does not exist
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { attachmentId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { id?: number; metadata?: string; url?: string }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get attachment metadata
Description
Retrieve the attachment metadata.
The authenticated user must have REPO_READ permission for the specified repository that is associated to the attachment that has the attachment metadata.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { attachmentId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { attachmentId: string; projectKey: string; repositorySlug: string }
 - ReadonlyattachmentId: string
 Description
 the attachment ID
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; metadata?: string; url?: string }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; metadata?: string; url?: string }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The attachment metadata
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the attachment metadata
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The attachment or the attachment metadata does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { attachmentId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": string } }; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Save attachment metadata
Description
Save attachment metadata.
The authenticated user must have REPO_READ permission for the specified repository that is associated to the attachment that has the attachment metadata.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { attachmentId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { attachmentId: string; projectKey: string; repositorySlug: string }
 - ReadonlyattachmentId: string
 Description
 the attachment ID
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": string } }
 Description
 The attachment metadata can be any valid JSON content
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The attachment metadata
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The supplied content is not valid JSON
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to save theattachment metadata
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository or the attachment does not exist
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/branches`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/branches": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                base?: string;
                boostMatches?: boolean;
                context?: string;
                details?: boolean;
                filterText?: string;
                limit?: number;
                orderBy?: "ALPHABETICAL" | "MODIFICATION";
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            default?: boolean;
                            displayId?: string;
                            id?: string;
                            latestChangeset?: string;
                            latestCommit?: string;
                            type?: unknown;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    message?: string;
                    name?: string;
                    startPoint?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        default?: boolean;
                        displayId?: string;
                        id?: string;
                        latestChangeset?: string;
                        latestCommit?: string;
                        type?: unknown;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { base?: string; boostMatches?: boolean; context?: string; details?: boolean; filterText?: string; limit?: number; orderBy?: "ALPHABETICAL" | "MODIFICATION"; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find branches
Description
Retrieve the branches matching the supplied filterText param.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { base?: string; boostMatches?: boolean; context?: string; details?: boolean; filterText?: string; limit?: number; orderBy?: "ALPHABETICAL" | "MODIFICATION"; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { base?: string; boostMatches?: boolean; context?: string; details?: boolean; filterText?: string; limit?: number; orderBy?: "ALPHABETICAL" | "MODIFICATION"; start?: number; }
 - Optional Readonlybase?: string
 Description
 Base branch or tag to compare each branch to (for the metadata providers that uses that information
 - Optional ReadonlyboostMatches?: boolean
 Description
 Controls whether exact and prefix matches will be boosted to the top
 - Optional Readonlycontext?: string
 - Optional Readonlydetails?: boolean
 Description
 Whether to retrieve plugin-provided metadata about each branch
 - Optional ReadonlyfilterText?: string
 Description
 The text to match on
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional ReadonlyorderBy?: "ALPHABETICAL" | "MODIFICATION"
 Description
 Ordering of refs either ALPHABETICAL (by name) or MODIFICATION (last updated)
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The branches matching the supplied filterText.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to read the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { message?: string; name?: string; startPoint?: string; }; }; }; responses: { "200": { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create branch
Description
Creates a branch using the information provided in the RestCreateBranchRequest request
The authenticated user must have REPO_WRITE permission for the context repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { message?: string; name?: string; startPoint?: string; }; }; }
 Description
 The request to create a branch containing a name, startPoint, and optionally a message
- Readonlyresponses: { "200": { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The created branch.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to write to the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/branches/default`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/branches/default": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        default?: boolean;
                        displayId?: string;
                        id?: string;
                        latestChangeset?: string;
                        latestCommit?: string;
                        type?: unknown;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    default?: boolean;
                    displayId?: string;
                    id?: string;
                    latestChangeset?: string;
                    latestCommit?: string;
                    type?: unknown;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get default branch
Deprecated
Description
Retrieves the repository's default branch, if it has been created. If the repository is empty, 204 No Content will be returned. For non-empty repositories, if the configured default branch has not yet been created a 404 Not Found will be returned.
This URL is deprecated. Callers should use <code>GET /projects/{key}/repos/{slug}/default-branch</code> instead, which allows retrieving the configured default branch even if the ref has not been created yet. The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The configured default branch for the repository.
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The repository is empty, and has no default branch.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to read the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist, or its configured default branch does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update default branch
Deprecated
Description
Update the default branch of a repository.
This URL is deprecated. Callers should use <code>PUT /projects/{key}/repos/{slug}/default-branch</code> instead. The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; }
 Description
 The branch to set as default
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The operation was successful.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/browse`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/browse": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                at?: string;
                blame?: string;
                noContent?: string;
                size?: string;
                type?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; blame?: string; noContent?: string; size?: string; type?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get file content at revision
Description
Retrieve a page of content for a file path at a specified revision.
Responses from this endpoint vary widely depending on the query parameters. The example JSON is for a request that does not use size, type, blame or noContent. 1. size will return a response like {"size":10000} 2. type will return a response like {"type":"FILE"}, where possible values are "DIRECTORY", "FILE" and "SUBMODULE" 3. blame without noContent will include blame for the lines of content returned on the page 4. blame with noContent will omit file contents and only return blame for the requested lines 5. noContent without blame is ignored and does nothing The various parameters are "processed" in the above order. That means ?size=true&type=truewill return a size response, not a type one; the type parameter will be ignored. The blame and noContent query parameters are handled differently from size and type. For blame and noContent, the presence of the parameter implies "true" if no value is specified; size and and type both require an explicit=true or they're treated as "false". - ?blame is the same as ?blame=true - ?blame&noContent is the same as ?blame=true&noContent=true - ?size is the same as ?size=false - ?type is the same as ?type=false The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; blame?: string; noContent?: string; size?: string; type?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string; blame?: string; noContent?: string; size?: string; type?: string; }
 - Optional Readonlyat?: string
 Description
 The commit ID or ref to retrieve the content for
 - Optional Readonlyblame?: string
 Description
 If present and not equal to 'false', the blame will be returned for the file as well
 - Optional ReadonlynoContent?: string
 Description
 If blame&noContent only the blame is retrieved instead of the contents
 - Optional Readonlysize?: string
 Description
 If true only the size will be returned for the file path instead of the contents
 - Optional Readonlytype?: string
 Description
 If true only the type will be returned for the file path instead of the contents
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of contents from a file.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The path parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/browse/{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/browse/{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { path: string; projectKey: string; repositorySlug: string };
            query?: {
                at?: string;
                blame?: string;
                noContent?: string;
                size?: string;
                type?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { path: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "multipart/form-data": {
                    branch?: string;
                    content?: string;
                    message?: string;
                    sourceBranch?: string;
                    sourceCommitId?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        author?: {
                            avatarUrl?: string;
                            emailAddress?: string;
                            name?: string;
                        };
                        authorTimestamp?: number;
                        committer?: {
                            avatarUrl?: string;
                            emailAddress?: string;
                            name?: string;
                        };
                        committerTimestamp?: number;
                        displayId?: string;
                        id?: string;
                        message?: string;
                        parents?: readonly { displayId?: string; id?: string }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { at?: string; blame?: string; noContent?: string; size?: string; type?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get file content
Description
Retrieve a page of content for a file path at a specified revision.
Responses from this endpoint vary widely depending on the query parameters. The example JSON is for a request that does not use size, type, blame or noContent. 1. size will return a response like {"size":10000} 2. type will return a response like {"type":"FILE"}, where possible values are "DIRECTORY", "FILE" and "SUBMODULE" 3. blame without noContent will include blame for the lines of content returned on the page 4. blame with noContent will omit file contents and only return blame for the requested lines 5. noContent without blame is ignored and does nothing The various parameters are "processed" in the above order. That means ?size=true&type=truewill return a size response, not a type one; the type parameter will be ignored. The blame and noContent query parameters are handled differently from size and type. For blame and noContent, the presence of the parameter implies "true" if no value is specified; size and and type both require an explicit=true or they're treated as "false". - ?blame is the same as ?blame=true - ?blame&noContent is the same as ?blame=true&noContent=true - ?size is the same as ?size=false - ?type is the same as ?type=false The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { at?: string; blame?: string; noContent?: string; size?: string; type?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { path: string; projectKey: string; repositorySlug: string }
 - Readonlypath: string
 Description
 The file path to retrieve content from
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string; blame?: string; noContent?: string; size?: string; type?: string; }
 - Optional Readonlyat?: string
 Description
 The commit ID or ref to retrieve the content for
 - Optional Readonlyblame?: string
 Description
 If present and not equal to 'false', the blame will be returned for the file as well
 - Optional ReadonlynoContent?: string
 Description
 If blame&noContent only the blame is retrieved instead of the contents
 - Optional Readonlysize?: string
 Description
 If true only the size will be returned for the file path instead of the contents
 - Optional Readonlytype?: string
 Description
 If true only the type will be returned for the file path instead of the contents
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of contents from a file.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The path or until parameters were not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "multipart/form-data": { branch?: string; content?: string; message?: string; sourceBranch?: string; sourceCommitId?: string; }; }; }; responses: { "200": { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string; }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string; }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Edit file
Description
Update the content of path, on the given repository and branch.
This resource accepts PUT multipart form data, containing the file in a form-field named content. An example <a href="http://curl.haxx.se/">curl</a> request to update 'README.md' would be: ```curl -X PUT -u username:password -F content=@README.md -F 'message=Updated using file-edit REST API' -F branch=master -F sourceCommitId=5636641a50b http://example.com/rest/api/latest/projects/PROJECT_1/repos/repo_1/browse/README.md ``` - branch: the branch on which the path should be modified or created - content: the full content of the file at path - message: the message associated with this change, to be used as the commit message. Or null if the default message should be used. - sourceCommitId: the commit ID of the file before it was edited, used to identify if content has changed. Or null if this is a new file The file can be updated or created on a new branch. In this case, the sourceBranch parameter should be provided to identify the starting point for the new branch and the branch parameter identifies the branch to create the new commit on.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { path: string; projectKey: string; repositorySlug: string }
 - Readonlypath: string
 Description
 The path of the file that is to be modified or created
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "multipart/form-data": { branch?: string; content?: string; message?: string; sourceBranch?: string; sourceCommitId?: string; }; }; }
 Description
 The multipart form data containing the file
- Readonlyresponses: { "200": { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created commit.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 There are validation errors, e.g. The branch or content parameters were not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user does not have write permission for the given repository.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was authenticated using a project or repository access token, which does not have a valid user associated with it
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The file already exists when trying to create a file, or the given content does not modify the file, or the file has changed since the given sourceCommitId, or the repository is archived.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/changes`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/changes": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                limit?: number;
                since?: string;
                start?: number;
                until?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            conflict?: { ourChange?: ...; theirChange?: ... };
                            contentId?: string;
                            executable?: boolean;
                            fromContentId?: string;
                            links?: Record<(...), (...)>;
                            nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE";
                            path?: {
                                components?: ...;
                                extension?: ...;
                                name?: ...;
                                parent?: ...;
                            };
                            percentUnchanged?: number;
                            srcExecutable?: boolean;
                            srcPath?: {
                                components?: ...;
                                extension?: ...;
                                name?: ...;
                                parent?: ...;
                            };
                            type?: "UNKNOWN"
                            | "DELETE"
                            | "ADD"
                            | "COPY"
                            | "MODIFY"
                            | "MOVE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; since?: string; start?: number; until?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { conflict?: { ourChange?: ...; theirChange?: ... }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<(...), (...)>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: ...; extension?: ...; name?: ...; parent?: ... }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: ...; extension?: ...; name?: ...; parent?: ...; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get changes made in commit
Description
Retrieve a page of changes made in a specified commit.
Note: The implementation will apply a hard cap ({@code page.max.changes}) and it is not possible to request subsequent content when that cap is exceeded. The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; since?: string; start?: number; until?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; since?: string; start?: number; until?: string }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlysince?: string
 Description
 The commit to which until should be compared to produce a page of changes. If not specified the commit's first parent is assumed (if one exists)
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlyuntil?: string
 Description
 The commit to retrieve changes for
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { conflict?: { ourChange?: ...; theirChange?: ... }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<(...), (...)>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: ...; extension?: ...; name?: ...; parent?: ... }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: ...; extension?: ...; name?: ...; parent?: ...; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { conflict?: { ourChange?: ...; theirChange?: ... }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<(...), (...)>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: ...; extension?: ...; name?: ...; parent?: ... }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: ...; extension?: ...; name?: ...; parent?: ...; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of changes
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The until parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository or the since or until parameters supplied does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                avatarScheme?: string;
                avatarSize?: string;
                followRenames?: string;
                ignoreMissing?: string;
                limit?: number;
                merges?: string;
                path?: string;
                since?: string;
                start?: number;
                until?: string;
                withCounts?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
                            authorTimestamp?: number;
                            committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
                            committerTimestamp?: number;
                            displayId?: string;
                            id?: string;
                            message?: string;
                            parents?: readonly (...)[];
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { avatarScheme?: string; avatarSize?: string; followRenames?: string; ignoreMissing?: string; limit?: number; merges?: string; path?: string; since?: string; start?: number; until?: string; withCounts?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; authorTimestamp?: number; committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get commits
Description
Retrieve a page of commits from a given starting commit or "between" two commits. If no explicit commit is specified, the tip of the repository's default branch is assumed. commits may be identified by branch or tag name or by ID. A path may be supplied to restrict the returned commits to only those which affect that path.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { avatarScheme?: string; avatarSize?: string; followRenames?: string; ignoreMissing?: string; limit?: number; merges?: string; path?: string; since?: string; start?: number; until?: string; withCounts?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { avatarScheme?: string; avatarSize?: string; followRenames?: string; ignoreMissing?: string; limit?: number; merges?: string; path?: string; since?: string; start?: number; until?: string; withCounts?: string; }
 - Optional ReadonlyavatarScheme?: string
 Description
 The desired scheme for the avatar URL. If the parameter is not present URLs will use the same scheme as this request
 - Optional ReadonlyavatarSize?: string
 Description
 If present the service adds avatar URLs for commit authors. Should be an integer specifying the desired size in pixels. If the parameter is not present, avatar URLs will not be set
 - Optional ReadonlyfollowRenames?: string
 Description
 If true, the commit history of the specified file will be followed past renames. Only valid for a path to a single file.
 - Optional ReadonlyignoreMissing?: string
 Description
 true to ignore missing commits, false otherwise
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlymerges?: string
 Description
 If present, controls how merge commits should be filtered. Can be either exclude, to exclude merge commits, include, to include both merge commits and non-merge commits or only, to only return merge commits.
 - Optional Readonlypath?: string
 Description
 An optional path to filter commits by
 - Optional Readonlysince?: string
 Description
 The commit ID or ref (exclusively) to retrieve commits after
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlyuntil?: string
 Description
 The commit ID (SHA1) or ref (inclusively) to retrieve commits before
 - Optional ReadonlywithCounts?: string
 Description
 Optionally include the total number of commits and total number of unique authors
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; authorTimestamp?: number; committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; authorTimestamp?: number; committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of commits
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One of the supplied commit IDs or refs was invalid.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: { path?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        author?: {
                            avatarUrl?: string;
                            emailAddress?: string;
                            name?: string;
                        };
                        authorTimestamp?: number;
                        committer?: {
                            avatarUrl?: string;
                            emailAddress?: string;
                            name?: string;
                        };
                        committerTimestamp?: number;
                        displayId?: string;
                        id?: string;
                        message?: string;
                        parents?: readonly { displayId?: string; id?: string }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { path?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string; }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string; }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get commit by ID
Description
Retrieve a single commit identified by its ID. In general, that ID is a SHA1. From 2.11, ref names like "refs/heads/master" are no longer accepted by this resource.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { path?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit ID to retrieve
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { path?: string }
 - Optional Readonlypath?: string
 Description
 An optional path to filter the commit by. If supplied the details returned may not be for the specified commit. Instead, starting from the specified commit, they will be the details for the first commit affecting the specified path.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A commit
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The supplied commit ID was invalid
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/builds`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/builds": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: { key?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query: { key: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        buildNumber?: string;
                        createdDate?: number;
                        description?: string;
                        duration?: number;
                        key?: string;
                        name?: string;
                        parent?: string;
                        ref?: string;
                        state?: | "FAILED"
                        | "INPROGRESS"
                        | "SUCCESSFUL"
                        | "UNKNOWN"
                        | "CANCELLED";
                        testResults?: {
                            failed?: number;
                            skipped?: number;
                            successful?: number;
                        };
                        updatedDate?: number;
                        url?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "*/*": {
                    buildNumber?: string;
                    description?: string;
                    duration?: number;
                    key: string;
                    lastUpdated?: number;
                    name?: string;
                    parent?: string;
                    ref?: string;
                    state: "FAILED"
                    | "INPROGRESS"
                    | "SUCCESSFUL"
                    | "UNKNOWN"
                    | "CANCELLED";
                    testResults?: {
                        failed?: number;
                        skipped?: number;
                        successful?: number;
                    };
                    url: string;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { key?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a specific build status
Description
Delete a specific build status.
The authenticated user must have **REPO_ADMIN** permission for the provided repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { key?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { key?: string }
 - Optional Readonlykey?: string
 Description
 the key of the build status
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The build status associated with the provided commit and key has been deleted
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions this repository
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query: { key: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { buildNumber?: string; createdDate?: number; description?: string; duration?: number; key?: string; name?: string; parent?: string; ref?: string; state?: | "FAILED" | "INPROGRESS" | "SUCCESSFUL" | "UNKNOWN" | "CANCELLED"; testResults?: { failed?: number; skipped?: number; successful?: number; }; updatedDate?: number; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a specific build status
Description
Get a specific build status.
The authenticated user must have **REPO_READ** permission for the provided repository.The request can also be made with anonymous 2-legged OAuth. Since 7.14
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query: { key: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Readonlyquery: { key: string }
 - Readonlykey: string
 Description
 the key of the build status
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { buildNumber?: string; createdDate?: number; description?: string; duration?: number; key?: string; name?: string; parent?: string; ref?: string; state?: "FAILED" | "INPROGRESS" | "SUCCESSFUL" | "UNKNOWN" | "CANCELLED"; testResults?: { failed?: number; skipped?: number; successful?: number }; updatedDate?: number; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { buildNumber?: string; createdDate?: number; description?: string; duration?: number; key?: string; name?: string; parent?: string; ref?: string; state?: "FAILED" | "INPROGRESS" | "SUCCESSFUL" | "UNKNOWN" | "CANCELLED"; testResults?: { failed?: number; skipped?: number; successful?: number }; updatedDate?: number; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The build status associated with the provided commit and key
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions this repository
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository, commit or build status does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "*/*": { buildNumber?: string; description?: string; duration?: number; key: string; lastUpdated?: number; name?: string; parent?: string; ref?: string; state: "FAILED" | "INPROGRESS" | "SUCCESSFUL" | "UNKNOWN" | "CANCELLED"; testResults?: { failed?: number; skipped?: number; successful?: number }; url: string; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Store a build status
Description
Store a build status.
The authenticated user must have **REPO_READ** permission for the repository that this build status is for. The request can also be made with anonymous 2-legged OAuth.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "*/*": { buildNumber?: string; description?: string; duration?: number; key: string; lastUpdated?: number; name?: string; parent?: string; ref?: string; state: "FAILED" | "INPROGRESS" | "SUCCESSFUL" | "UNKNOWN" | "CANCELLED"; testResults?: { failed?: number; skipped?: number; successful?: number }; url: string; }; }; }
 Description
 The contents of the build status request are: These fields are required:
 - **key**: The string referring to this branch plan/job - **state**: The build status state, one of: "SUCCESSFUL", "FAILED", "INPROGRESS", "CANCELLED", "UNKNOWN" - **url**: URL referring to the build result page in the CI tool. These fields are optional: - **buildNumber** (optional): A unique identifier for this particular run of a plan< - **dateAdded** (optional): milliseconds since epoch. If not provided current date is used. - **description** (optional): Describes the build result - **duration** (optional): Duration of a completed build in milliseconds. - **name** (optional): A short string that describes the build plan - **parent** (optional): The identifier for the plan or job that ran the branch plan that produced this build status. - **ref** (optional): The fully qualified git reference e.g. refs/heads/master. - **testResults** (optional): A summary of the passed, failed and skipped tests.
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The build status was posted
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The build status was not added as the request was invalid. This could be because of a number of things:
 - an invalid commit hash was provided - build key was blank or longer than 255 characters - invalid branch was provided - invalid state was provided - build status url was blank or longer than 450 characters The specifics will be included in the error message.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to push a build status to this repository
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/changes`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/changes": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: {
                limit?: number;
                since?: string;
                start?: number;
                withComments?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            conflict?: { ourChange?: ...; theirChange?: ... };
                            contentId?: string;
                            executable?: boolean;
                            fromContentId?: string;
                            links?: Record<(...), (...)>;
                            nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE";
                            path?: {
                                components?: ...;
                                extension?: ...;
                                name?: ...;
                                parent?: ...;
                            };
                            percentUnchanged?: number;
                            srcExecutable?: boolean;
                            srcPath?: {
                                components?: ...;
                                extension?: ...;
                                name?: ...;
                                parent?: ...;
                            };
                            type?: "UNKNOWN"
                            | "DELETE"
                            | "ADD"
                            | "COPY"
                            | "MODIFY"
                            | "MOVE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { limit?: number; since?: string; start?: number; withComments?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { conflict?: { ourChange?: ...; theirChange?: ... }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<(...), (...)>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: ...; extension?: ...; name?: ...; parent?: ... }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: ...; extension?: ...; name?: ...; parent?: ...; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get changes in commit
Description
Retrieve a page of changes made in a specified commit.
Note: The implementation will apply a hard cap (<code>page.max.changes</code>) and it is not possible to request subsequent content when that cap is exceeded. The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { limit?: number; since?: string; start?: number; withComments?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit to retrieve changes for
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { limit?: number; since?: string; start?: number; withComments?: string }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlysince?: string
 Description
 The commit to which until should be compared to produce a page of changes. If not specified the commit's first parent is assumed (if one exists)
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional ReadonlywithComments?: string
 Description
 true to apply comment counts in the changes (the default); otherwise, false to stream changes without comment counts
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { conflict?: { ourChange?: ...; theirChange?: ... }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<(...), (...)>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: ...; extension?: ...; name?: ...; parent?: ... }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: ...; extension?: ...; name?: ...; parent?: ...; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { conflict?: { ourChange?: ...; theirChange?: ... }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<(...), (...)>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: ...; extension?: ...; name?: ...; parent?: ... }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: ...; extension?: ...; name?: ...; parent?: ...; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of changes
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The until parameter was not supplied
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository or the since or until parameters supplied does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: { limit?: number; path?: string; since?: string; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            anchor?: {
                                diffType?: ...;
                                fileType?: ...;
                                fromHash?: ...;
                                line?: ...;
                                lineType?: ...;
                                multilineMarker?: ...;
                                path?: ...;
                                pullRequest?: ...;
                                srcPath?: ...;
                                toHash?: ...;
                            };
                            anchored?: boolean;
                            author?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            parent?: {
                                anchor?: ...;
                                anchored?: ...;
                                author?: ...;
                                comments?: ...;
                                createdDate?: ...;
                                html?: ...;
                                id?: ...;
                                pending?: ...;
                                properties?: ...;
                                reply?: ...;
                                resolvedDate?: ...;
                                resolver?: ...;
                                severity?: ...;
                                state?: ...;
                                text?: ...;
                                threadResolved?: ...;
                                threadResolvedDate?: ...;
                                threadResolver?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            };
                            pending?: boolean;
                            properties?: Record<(...), (...)>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: { since?: string };
        };
        requestBody?: {
            content: {
                "application/json": {
                    anchor?: {
                        diffType?: "COMMIT"
                        | "EFFECTIVE"
                        | "RANGE";
                        fileType?: "FROM" | "TO";
                        fromHash?: string;
                        line?: number;
                        lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                        multilineMarker?: {
                            startLine?: (...) | (...);
                            startLineType: (...) | (...) | (...);
                        };
                        path?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        pullRequest?: {
                            closed?: (...)
                            | (...)
                            | (...);
                            closedDate?: (...) | (...);
                            createdDate?: (...) | (...);
                            description?: (...) | (...);
                            descriptionAsHtml?: (...) | (...);
                            draft?: (...) | (...) | (...);
                            fromRef?: (...) | (...);
                            htmlDescription?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            locked?: (...) | (...) | (...);
                            open?: (...) | (...) | (...);
                            participants?: (...) | (...);
                            reviewers?: (...) | (...);
                            state?: (...) | (...) | (...) | (...);
                            title?: (...) | (...);
                            toRef?: (...) | (...);
                            updatedDate?: (...) | (...);
                            version?: (...) | (...);
                        };
                        srcPath?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        toHash?: string;
                    };
                    anchored?: boolean;
                    author?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    comments?: readonly (
                        { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                    )[];
                    createdDate?: number;
                    html?: string;
                    id?: number;
                    parent?: {
                        anchor?: {
                            diffType?: (...)
                            | (...)
                            | (...)
                            | (...);
                            fileType?: (...) | (...) | (...);
                            fromHash?: (...) | (...);
                            line?: (...) | (...);
                            lineType?: (...) | (...) | (...) | (...);
                            multilineMarker?: (...) | (...);
                            path?: (...) | (...);
                            pullRequest?: (...) | (...);
                            srcPath?: (...) | (...);
                            toHash?: (...) | (...);
                        };
                        anchored?: boolean;
                        author?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: (...) | (...) | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                    pending?: boolean;
                    properties?: Record<string, unknown>;
                    reply?: boolean;
                    resolvedDate?: number;
                    resolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    severity?: string;
                    state?: string;
                    text?: string;
                    threadResolved?: boolean;
                    threadResolvedDate?: number;
                    threadResolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    updatedDate?: number;
                    version?: number;
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        anchor?: {
                            diffType?: "COMMIT"
                            | "EFFECTIVE"
                            | "RANGE";
                            fileType?: "FROM" | "TO";
                            fromHash?: string;
                            line?: number;
                            lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                            multilineMarker?: {
                                startLine?: (...) | (...);
                                startLineType: (...) | (...) | (...);
                            };
                            path?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            pullRequest?: {
                                closed?: (...)
                                | (...)
                                | (...);
                                closedDate?: (...) | (...);
                                createdDate?: (...) | (...);
                                description?: (...) | (...);
                                descriptionAsHtml?: (...) | (...);
                                draft?: (...) | (...) | (...);
                                fromRef?: (...) | (...);
                                htmlDescription?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                locked?: (...) | (...) | (...);
                                open?: (...) | (...) | (...);
                                participants?: (...) | (...);
                                reviewers?: (...) | (...);
                                state?: (...) | (...) | (...) | (...);
                                title?: (...) | (...);
                                toRef?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            srcPath?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            toHash?: string;
                        };
                        anchored?: boolean;
                        author?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        parent?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly (
                                { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                            )[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { limit?: number; path?: string; since?: string; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Search for commit comments
Description
Retrieves the commit discussion comments that match the specified search criteria.
It is possible to retrieve commit discussion comments that are anchored to a range of commits by providing the sinceId that the comments anchored from. The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { limit?: number; path?: string; since?: string; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The full ID of the commit within the repository
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { limit?: number; path?: string; since?: string; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlypath?: string
 Description
 The path to the file on which comments were made
 - Optional Readonlysince?: string
 Description
 For a merge commit, a parent can be provided to specify which diff the comments are on. For a commit range, a sinceId can be provided to specify where the comments are anchored from.
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of comments that match the search criteria
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the comment
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, or commit. The missing entity will be specified in the error details.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { since?: string }; }; requestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }; responses: { "201": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add a new commit comment
Description
Add a new comment.
Comments can be added in a few places by setting different attributes: General commit comment: ```{ "text": "An insightful general comment on a commit." } </pre> Reply to a comment: <pre>{ "text": "A measured reply.", "parent": { "id": 1 } } </pre> General file comment: <pre>{ "text": "An insightful general comment on a file.", "anchor": { "diffType": "COMMIT", "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd", "path": "path/to/file", "srcPath": "path/to/file", "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b" } } </pre> File line comment: <pre>{ "text": "A pithy comment on a particular line within a file.", "anchor": { "diffType": "COMMIT", "line": 1, "lineType": "CONTEXT", "fileType": "FROM", "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd", "path": "path/to/file", "srcPath": "path/to/file", "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b" } } ``` Note: general file comments are an experimental feature and may change in the near future! For file and line comments, 'path' refers to the path of the file to which the comment should be applied and 'srcPath' refers to the path the that file used to have (only required for copies and moves). Also, fromHash and toHash refer to the sinceId / untilId (respectively) used to produce the diff on which the comment was added. Finally diffType refers to the type of diff the comment was added on. For line comments, 'line' refers to the line in the diff that the comment should apply to. 'lineType' refers to the type of diff hunk, which can be:- 'ADDED' - for an added line;</li>- 'REMOVED' - for a removed line; or</li>- 'CONTEXT' - for a line that was unmodified but is in the vicinity of the diff.</li>'fileType' refers to the file of the diff to which the anchor should be attached - which is of relevance when displaying the diff in a side-by-side way. Currently the supported values are:- 'FROM' - the source file of the diff</li>- 'TO' - the destination file of the diff</li>If the current user is not a participant the user is added as one and updated to watch the commit. The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { since?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The full ID of the commit within the repository
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { since?: string }
 - Optional Readonlysince?: string
 Description
 For a merge commit, a parent can be provided to specify which diff the comments should be on. For a commit range, a sinceId can be provided to specify where the comments should be anchored from.
- Optional ReadonlyrequestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }
 Description
 the comment
- Readonlyresponses: { "201": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created comment.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment was not created due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the commit, create a comment or watch the commit.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, commit or parent comment. The missing entity will be specified in the error details.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Adding, deleting, or editing comments isn't supported on archived repositories.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                commitId: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: { version?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                commitId: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        anchor?: {
                            diffType?: "COMMIT"
                            | "EFFECTIVE"
                            | "RANGE";
                            fileType?: "FROM" | "TO";
                            fromHash?: string;
                            line?: number;
                            lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                            multilineMarker?: {
                                startLine?: (...) | (...);
                                startLineType: (...) | (...) | (...);
                            };
                            path?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            pullRequest?: {
                                closed?: (...)
                                | (...)
                                | (...);
                                closedDate?: (...) | (...);
                                createdDate?: (...) | (...);
                                description?: (...) | (...);
                                descriptionAsHtml?: (...) | (...);
                                draft?: (...) | (...) | (...);
                                fromRef?: (...) | (...);
                                htmlDescription?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                locked?: (...) | (...) | (...);
                                open?: (...) | (...) | (...);
                                participants?: (...) | (...);
                                reviewers?: (...) | (...);
                                state?: (...) | (...) | (...) | (...);
                                title?: (...) | (...);
                                toRef?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            srcPath?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            toHash?: string;
                        };
                        anchored?: boolean;
                        author?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        parent?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly (
                                { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                            )[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                commitId: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    anchor?: {
                        diffType?: "COMMIT"
                        | "EFFECTIVE"
                        | "RANGE";
                        fileType?: "FROM" | "TO";
                        fromHash?: string;
                        line?: number;
                        lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                        multilineMarker?: {
                            startLine?: (...) | (...);
                            startLineType: (...) | (...) | (...);
                        };
                        path?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        pullRequest?: {
                            closed?: (...)
                            | (...)
                            | (...);
                            closedDate?: (...) | (...);
                            createdDate?: (...) | (...);
                            description?: (...) | (...);
                            descriptionAsHtml?: (...) | (...);
                            draft?: (...) | (...) | (...);
                            fromRef?: (...) | (...);
                            htmlDescription?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            locked?: (...) | (...) | (...);
                            open?: (...) | (...) | (...);
                            participants?: (...) | (...);
                            reviewers?: (...) | (...);
                            state?: (...) | (...) | (...) | (...);
                            title?: (...) | (...);
                            toRef?: (...) | (...);
                            updatedDate?: (...) | (...);
                            version?: (...) | (...);
                        };
                        srcPath?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        toHash?: string;
                    };
                    anchored?: boolean;
                    author?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    comments?: readonly (
                        { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                    )[];
                    createdDate?: number;
                    html?: string;
                    id?: number;
                    parent?: {
                        anchor?: {
                            diffType?: (...)
                            | (...)
                            | (...)
                            | (...);
                            fileType?: (...) | (...) | (...);
                            fromHash?: (...) | (...);
                            line?: (...) | (...);
                            lineType?: (...) | (...) | (...) | (...);
                            multilineMarker?: (...) | (...);
                            path?: (...) | (...);
                            pullRequest?: (...) | (...);
                            srcPath?: (...) | (...);
                            toHash?: (...) | (...);
                        };
                        anchored?: boolean;
                        author?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: (...) | (...) | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                    pending?: boolean;
                    properties?: Record<string, unknown>;
                    reply?: boolean;
                    resolvedDate?: number;
                    resolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    severity?: string;
                    state?: string;
                    text?: string;
                    threadResolved?: boolean;
                    threadResolvedDate?: number;
                    threadResolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    updatedDate?: number;
                    version?: number;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        anchor?: {
                            diffType?: "COMMIT"
                            | "EFFECTIVE"
                            | "RANGE";
                            fileType?: "FROM" | "TO";
                            fromHash?: string;
                            line?: number;
                            lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                            multilineMarker?: {
                                startLine?: (...) | (...);
                                startLineType: (...) | (...) | (...);
                            };
                            path?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            pullRequest?: {
                                closed?: (...)
                                | (...)
                                | (...);
                                closedDate?: (...) | (...);
                                createdDate?: (...) | (...);
                                description?: (...) | (...);
                                descriptionAsHtml?: (...) | (...);
                                draft?: (...) | (...) | (...);
                                fromRef?: (...) | (...);
                                htmlDescription?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                locked?: (...) | (...) | (...);
                                open?: (...) | (...) | (...);
                                participants?: (...) | (...);
                                reviewers?: (...) | (...);
                                state?: (...) | (...) | (...) | (...);
                                title?: (...) | (...);
                                toRef?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            srcPath?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            toHash?: string;
                        };
                        anchored?: boolean;
                        author?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        parent?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly (
                                { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                            )[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; commitId: string; projectKey: string; repositorySlug: string; }; query?: { version?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a commit comment
Description
Delete a commit comment. Anyone can delete their own comment. Only users with REPO_ADMIN and above may delete comments created by other users. Comments which have replies may not be deleted, regardless of the user's granted permissions.
The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; commitId: string; projectKey: string; repositorySlug: string; }; query?: { version?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; commitId: string; projectKey: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 the comment
 - ReadonlycommitId: string
 Description
 The full ID of the commit within the repository
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { version?: string }
 - Optional Readonlyversion?: string
 Description
 The expected version of the comment. This must match the server's version of the comment or the delete will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the delete. Look for the 'version' attribute in the returned JSON structure.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The operation was successful
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the comment.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository or commit. The missing entity will be specified in the error details.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment has replies, the version supplied does not match the comment's current version or the repository is archived.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; commitId: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a commit comment
Description
Retrieves a commit discussion comment.
The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; commitId: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; commitId: string; projectKey: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The ID of the comment to retrieve
 - ReadonlycommitId: string
 Description
 The full ID of the commit within the repository
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested comment.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the comment
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, commit or comment. The missing entity will be specified in the error details.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; commitId: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }; responses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update a commit comment
Description
Update a comment, with the following restrictions:
- only the author of the comment may update the text of the comment - only the author of the comment or repository admins and above may update the other fields of a comment Note: the supplied supplied JSON object must contain a <code>version</code> that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure. The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; commitId: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; commitId: string; projectKey: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The ID of the comment to retrieve
 - ReadonlycommitId: string
 Description
 The full ID of the commit within the repository
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }
 Description
 The comment to update
- Readonlyresponses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly updated comment.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment was not updated due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the commit, update the comment or watch the commit.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, commit or comment. The missing entity will be specified in the error details.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment version supplied does not match the current version or the repository is archived.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/deployments`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/deployments": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: {
                deploymentSequenceNumber?: string;
                environmentKey?: string;
                key?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: {
                deploymentSequenceNumber?: string;
                environmentKey?: string;
                key?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        deploymentSequenceNumber?: number;
                        description?: string;
                        displayName?: string;
                        environment?: {
                            displayName: string;
                            key: string;
                            type?: string;
                            url?: string;
                        };
                        fromCommit?: { displayId?: string; id?: string };
                        key?: string;
                        lastUpdated?: number;
                        repository?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            origin?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            partition?: number;
                            project?: {
                                avatar?: (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                        state?: | "FAILED"
                        | "SUCCESSFUL"
                        | "IN_PROGRESS"
                        | "PENDING"
                        | "UNKNOWN"
                        | "CANCELLED"
                        | "ROLLED_BACK";
                        toCommit?: { displayId?: string; id?: string };
                        url?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "*/*": {
                    deploymentSequenceNumber: number;
                    description: string;
                    displayName: string;
                    environment: {
                        displayName?: string;
                        key?: string;
                        type?: string;
                        url?: string;
                    };
                    key: string;
                    lastUpdated?: number;
                    state: | "FAILED"
                    | "SUCCESSFUL"
                    | "IN_PROGRESS"
                    | "PENDING"
                    | "UNKNOWN"
                    | "CANCELLED"
                    | "ROLLED_BACK";
                    url: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        deploymentSequenceNumber?: number;
                        description?: string;
                        displayName?: string;
                        environment?: {
                            displayName: string;
                            key: string;
                            type?: string;
                            url?: string;
                        };
                        fromCommit?: { displayId?: string; id?: string };
                        key?: string;
                        lastUpdated?: number;
                        repository?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            origin?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            partition?: number;
                            project?: {
                                avatar?: (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                        state?: | "FAILED"
                        | "SUCCESSFUL"
                        | "IN_PROGRESS"
                        | "PENDING"
                        | "UNKNOWN"
                        | "CANCELLED"
                        | "ROLLED_BACK";
                        toCommit?: { displayId?: string; id?: string };
                        url?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { deploymentSequenceNumber?: string; environmentKey?: string; key?: string; }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a deployment
Description
Delete the deployment matching the specified Repository, key, environmentKey and deploymentSequenceNumber.
The user must have REPO_ADMIN.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { deploymentSequenceNumber?: string; environmentKey?: string; key?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 the commitId that was deployed as indicated by the path
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { deploymentSequenceNumber?: string; environmentKey?: string; key?: string }
 - Optional ReadonlydeploymentSequenceNumber?: string
 Description
 the sequence number of the deployment, as detailed by the query parameter
 - Optional ReadonlyenvironmentKey?: string
 Description
 the key of the environment, as detailed by the query parameter
 - Optional Readonlykey?: string
 Description
 the key of the deployment, as detailed by the query parameter
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 the request has been processed
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 the deployment was not deleted because the request was invalid
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete a deployment
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { deploymentSequenceNumber?: string; environmentKey?: string; key?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { deploymentSequenceNumber?: number; description?: string; displayName?: string; environment?: { displayName: string; key: string; type?: string; url?: string; }; fromCommit?: { displayId?: string; id?: string }; key?: string; lastUpdated?: number; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; state?: | "FAILED" | "SUCCESSFUL" | "IN_PROGRESS" | "PENDING" | "UNKNOWN" | "CANCELLED" | "ROLLED_BACK"; toCommit?: { displayId?: string; id?: string }; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a deployment
Description
Get the deployment matching the specified Repository, key, environmentKey and deploymentSequenceNumber.
The user must have REPO_READ.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { deploymentSequenceNumber?: string; environmentKey?: string; key?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 the commitId that was deployed as indicated by the query parameter
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { deploymentSequenceNumber?: string; environmentKey?: string; key?: string }
 - Optional ReadonlydeploymentSequenceNumber?: string
 Description
 the sequence number of the deployment, as detailed by the query param
 Example
 deploymentSequenceNumber
 - Optional ReadonlyenvironmentKey?: string
 Description
 the key of the environment, as detailed by the query parameter
 - Optional Readonlykey?: string
 Description
 the key of the deployment, as detailed by the query parameter
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { deploymentSequenceNumber?: number; description?: string; displayName?: string; environment?: { displayName: string; key: string; type?: string; url?: string; }; fromCommit?: { displayId?: string; id?: string }; key?: string; lastUpdated?: number; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; state?: | "FAILED" | "SUCCESSFUL" | "IN_PROGRESS" | "PENDING" | "UNKNOWN" | "CANCELLED" | "ROLLED_BACK"; toCommit?: { displayId?: string; id?: string }; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { deploymentSequenceNumber?: number; description?: string; displayName?: string; environment?: { displayName: string; key: string; type?: string; url?: string; }; fromCommit?: { displayId?: string; id?: string }; key?: string; lastUpdated?: number; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; state?: | "FAILED" | "SUCCESSFUL" | "IN_PROGRESS" | "PENDING" | "UNKNOWN" | "CANCELLED" | "ROLLED_BACK"; toCommit?: { displayId?: string; id?: string }; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The deployment
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 could not get the deployment because the request was invalid
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or deployment does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "*/*": { deploymentSequenceNumber: number; description: string; displayName: string; environment: { displayName?: string; key?: string; type?: string; url?: string; }; key: string; lastUpdated?: number; state: | "FAILED" | "SUCCESSFUL" | "IN_PROGRESS" | "PENDING" | "UNKNOWN" | "CANCELLED" | "ROLLED_BACK"; url: string; }; }; }; responses: { "200": { content: { "application/json": { deploymentSequenceNumber?: number; description?: string; displayName?: string; environment?: { displayName: string; key: string; type?: string; url?: string; }; fromCommit?: { displayId?: string; id?: string }; key?: string; lastUpdated?: number; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; state?: | "FAILED" | "SUCCESSFUL" | "IN_PROGRESS" | "PENDING" | "UNKNOWN" | "CANCELLED" | "ROLLED_BACK"; toCommit?: { displayId?: string; id?: string }; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create or update a deployment
Description
Create or update a deployment.
The authenticated user must have REPO_READ permission for the repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 the commitId that was deployed as indicated by the path
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "*/*": { deploymentSequenceNumber: number; description: string; displayName: string; environment: { displayName?: string; key?: string; type?: string; url?: string; }; key: string; lastUpdated?: number; state: | "FAILED" | "SUCCESSFUL" | "IN_PROGRESS" | "PENDING" | "UNKNOWN" | "CANCELLED" | "ROLLED_BACK"; url: string; }; }; }
 Description
 the details of the deployment to create, as detailed by the request body
- Readonlyresponses: { "200": { content: { "application/json": { deploymentSequenceNumber?: number; description?: string; displayName?: string; environment?: { displayName: string; key: string; type?: string; url?: string; }; fromCommit?: { displayId?: string; id?: string }; key?: string; lastUpdated?: number; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; state?: | "FAILED" | "SUCCESSFUL" | "IN_PROGRESS" | "PENDING" | "UNKNOWN" | "CANCELLED" | "ROLLED_BACK"; toCommit?: { displayId?: string; id?: string }; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { deploymentSequenceNumber?: number; description?: string; displayName?: string; environment?: { displayName: string; key: string; type?: string; url?: string; }; fromCommit?: { displayId?: string; id?: string }; key?: string; lastUpdated?: number; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; state?: | "FAILED" | "SUCCESSFUL" | "IN_PROGRESS" | "PENDING" | "UNKNOWN" | "CANCELLED" | "ROLLED_BACK"; toCommit?: { displayId?: string; id?: string }; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The deployment was created
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 the deployment was not created because the request was invalid
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff-stats-summary/{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff-stats-summary/{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commitId: string;
                path: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: {
                autoSrcPath?: string;
                since?: string;
                srcPath?: string;
                whitespace?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; path: string; projectKey: string; repositorySlug: string; }; query?: { autoSrcPath?: string; since?: string; srcPath?: string; whitespace?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get diff stats summary between revisions
Description
Retrieve the diff stats summary for a commit.
The stats summary include the total number of modified files, added lines, and deleted lines. The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; path: string; projectKey: string; repositorySlug: string; }; query?: { autoSrcPath?: string; since?: string; srcPath?: string; whitespace?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; path: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit ID to diff to.
 - Readonlypath: string
 Description
 The path to the file which should be diffed (optional)
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { autoSrcPath?: string; since?: string; srcPath?: string; whitespace?: string }
 - Optional ReadonlyautoSrcPath?: string
 Description
 true to automatically try to find the source path when it's not provided, false otherwise. Requires the path to be provided.
 - Optional Readonlysince?: string
 Description
 The base revision to diff from. If omitted the parent revision of the commit ID is used
 - Optional ReadonlysrcPath?: string
 Description
 The source path for the file, if it was copied, moved or renamed
 - Optional Readonlywhitespace?: string
 Description
 Optional whitespace flag which can be set to ignore-all
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The diff stats summary for a commit.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The until parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff/{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff/{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commitId: string;
                path: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: {
                autoSrcPath?: string;
                avatarScheme?: string;
                avatarSize?: string;
                contextLines?: string;
                filter?: string;
                since?: string;
                srcPath?: string;
                whitespace?: string;
                withComments?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        binary?: boolean;
                        destination?: {
                            components?: readonly string[];
                            extension?: string;
                            name?: string;
                            parent?: string;
                        };
                        hunks?: readonly {
                            context?: string;
                            destinationLine?: number;
                            destinationSpan?: number;
                            segments?: readonly (...)[];
                            sourceLine?: number;
                            sourceSpan?: number;
                            truncated?: boolean;
                        }[];
                        lineComments?: readonly {
                            anchor?: {
                                diffType?: ...;
                                fileType?: ...;
                                fromHash?: ...;
                                line?: ...;
                                lineType?: ...;
                                multilineMarker?: ...;
                                path?: ...;
                                pullRequest?: ...;
                                srcPath?: ...;
                                toHash?: ...;
                            };
                            anchored?: boolean;
                            author?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            parent?: {
                                anchor?: ...;
                                anchored?: ...;
                                author?: ...;
                                comments?: ...;
                                createdDate?: ...;
                                html?: ...;
                                id?: ...;
                                pending?: ...;
                                properties?: ...;
                                reply?: ...;
                                resolvedDate?: ...;
                                resolver?: ...;
                                severity?: ...;
                                state?: ...;
                                text?: ...;
                                threadResolved?: ...;
                                threadResolvedDate?: ...;
                                threadResolver?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            };
                            pending?: boolean;
                            properties?: Record<(...), (...)>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                        properties?: Record<string, unknown>;
                        source?: {
                            components?: readonly string[];
                            extension?: string;
                            name?: string;
                            parent?: string;
                        };
                        truncated?: boolean;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; path: string; projectKey: string; repositorySlug: string; }; query?: { autoSrcPath?: string; avatarScheme?: string; avatarSize?: string; contextLines?: string; filter?: string; since?: string; srcPath?: string; whitespace?: string; withComments?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get diff between revisions
Description
Retrieve the diff between two provided revisions.
To stream a raw text representation of the diff, this endpoint can be called with the request header 'Accept: text/plain'. Note: This resource is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded. In the event that the cap is reached, the diff will be cut short and one or more {@code truncated} flags will be set to true on the "segments", "hunks" and "diffs" properties, as well as the top-level object, in the returned JSON response. The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; path: string; projectKey: string; repositorySlug: string; }; query?: { autoSrcPath?: string; avatarScheme?: string; avatarSize?: string; contextLines?: string; filter?: string; since?: string; srcPath?: string; whitespace?: string; withComments?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; path: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The full ID of the commit within the repository
 - Readonlypath: string
 Description
 The path to the file which should be diffed (optional)
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { autoSrcPath?: string; avatarScheme?: string; avatarSize?: string; contextLines?: string; filter?: string; since?: string; srcPath?: string; whitespace?: string; withComments?: string; }
 - Optional ReadonlyautoSrcPath?: string
 Description
 true to automatically try to find the source path when it's not provided, false otherwise. Requires the path to be provided.
 - Optional ReadonlyavatarScheme?: string
 Description
 The security scheme for avatar URLs. If the scheme is not present then it is inherited from the request. It can be set to "https" to force the use of secure URLs. Not applicable if streaming raw diff
 - Optional ReadonlyavatarSize?: string
 Description
 If present the service adds avatar URLs for comment authors where the provided value specifies the desired avatar size in pixels. Not applicable if streaming raw diff
 - Optional ReadonlycontextLines?: string
 Description
 The number of context lines to include around added/removed lines in the diff.Not applicable if streaming raw diff
 - Optional Readonlyfilter?: string
 Description
 Text used to filter files and lines (optional). Not applicable if streaming raw diff
 - Optional Readonlysince?: string
 Description
 The base revision to diff from. If omitted the parent revision of the until revision is used
 - Optional ReadonlysrcPath?: string
 Description
 The source path for the file, if it was copied, moved or renamed
 - Optional Readonlywhitespace?: string
 Description
 Optional whitespace flag which can be set to ignore-all
 - Optional ReadonlywithComments?: string
 Description
 true to embed comments in the diff (the default); otherwise false to stream the diff without comments. Not applicable if streaming raw diff
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A diff between two revisions.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The until parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/merge-base`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/merge-base": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: { otherCommitId?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        author?: {
                            avatarUrl?: string;
                            emailAddress?: string;
                            name?: string;
                        };
                        authorTimestamp?: number;
                        committer?: {
                            avatarUrl?: string;
                            emailAddress?: string;
                            name?: string;
                        };
                        committerTimestamp?: number;
                        displayId?: string;
                        id?: string;
                        message?: string;
                        parents?: readonly { displayId?: string; id?: string }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { otherCommitId?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string; }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string; }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get the common ancestor between two commits
Description
Returns the best common ancestor between two commits.
If more than one best common ancestor exists, only one will be returned. It is unspecified which will be returned.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { otherCommitId?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The full ID of the commit within the repository
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { otherCommitId?: string }
 - Optional ReadonlyotherCommitId?: string
 Description
 The other commit id to calculate the merge-base on
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The common ancestor of the two given commits
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 No common parent between the two commits exist
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The supplied commit ID(s) was/were invalid
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project, repository, or commit(s) does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/pull-requests`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/pull-requests": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            closed?: boolean;
                            closedDate?: number;
                            createdDate?: number;
                            description?: string;
                            descriptionAsHtml?: string;
                            draft?: boolean;
                            fromRef?: {
                                displayId?: ...;
                                id?: ...;
                                latestCommit?: ...;
                                repository?: ...;
                                type?: ...;
                            };
                            htmlDescription?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            locked?: boolean;
                            open?: boolean;
                            participants?: readonly (...)[];
                            reviewers?: readonly (...)[];
                            state?: "DECLINED" | "MERGED" | "OPEN";
                            title?: string;
                            toRef?: {
                                displayId?: ...;
                                id?: ...;
                                latestCommit?: ...;
                                repository?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; htmlDescription?: string; id?: number; links?: Record<(...), (...)>; locked?: boolean; open?: boolean; participants?: readonly (...)[]; reviewers?: readonly (...)[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository pull requests containing commit
Description
Retrieve a page of pull requests in the current repository that contain the given commit.
The user must be authenticated and have access to the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 the commit ID
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; htmlDescription?: string; id?: number; links?: Record<(...), (...)>; locked?: boolean; open?: boolean; participants?: readonly (...)[]; reviewers?: readonly (...)[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; htmlDescription?: string; id?: number; links?: Record<(...), (...)>; locked?: boolean; open?: boolean; participants?: readonly (...)[]; reviewers?: readonly (...)[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Return a page of pull requests in the current repository containing the given commit.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to see the request repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request repository does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/watch`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/watch": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Stop watching commit
Description
Remove the authenticated user as a watcher for the specified commit.
The authenticated user must have REPO_READ permission for the repository containing the commit to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The full ID of the commit within the repository
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The user is no longer watching the commit.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository or commit does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Watch commit
Description
Add the authenticated user as a watcher for the specified commit.
The authenticated user must have REPO_READ permission for the repository containing the commit to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The full ID of the commit within the repository
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The user is now watching the commit.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository or commit does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/changes`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/changes": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                from?: string;
                fromRepo?: string;
                limit?: number;
                start?: number;
                to?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            conflict?: { ourChange?: ...; theirChange?: ... };
                            contentId?: string;
                            executable?: boolean;
                            fromContentId?: string;
                            links?: Record<(...), (...)>;
                            nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE";
                            path?: {
                                components?: ...;
                                extension?: ...;
                                name?: ...;
                                parent?: ...;
                            };
                            percentUnchanged?: number;
                            srcExecutable?: boolean;
                            srcPath?: {
                                components?: ...;
                                extension?: ...;
                                name?: ...;
                                parent?: ...;
                            };
                            type?: "UNKNOWN"
                            | "DELETE"
                            | "ADD"
                            | "COPY"
                            | "MODIFY"
                            | "MOVE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { from?: string; fromRepo?: string; limit?: number; start?: number; to?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { conflict?: { ourChange?: ...; theirChange?: ... }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<(...), (...)>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: ...; extension?: ...; name?: ...; parent?: ... }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: ...; extension?: ...; name?: ...; parent?: ...; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Compare commits
Description
Gets the file changes available in the from commit but not in the to commit.
If either the <code> from</code> or <code> to</code> commit are not specified, they will be replaced by the default branch of their containing repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { from?: string; fromRepo?: string; limit?: number; start?: number; to?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { from?: string; fromRepo?: string; limit?: number; start?: number; to?: string; }
 - Optional Readonlyfrom?: string
 Description
 the source commit (can be a partial/full commit ID or qualified/unqualified ref name)
 - Optional ReadonlyfromRepo?: string
 Description
 an optional parameter specifying the source repository containing the source commit if that commit is not present in the current repository; the repository can be specified by either its ID fromRepo=42 or by its project key plus its repo slug separated by a slash: fromRepo=projectKey/repoSlug
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlyto?: string
 Description
 the target commit (can be a partial/full commit ID or qualified/unqualified ref name)
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { conflict?: { ourChange?: ...; theirChange?: ... }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<(...), (...)>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: ...; extension?: ...; name?: ...; parent?: ... }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: ...; extension?: ...; name?: ...; parent?: ...; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { conflict?: { ourChange?: ...; theirChange?: ... }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<(...), (...)>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: ...; extension?: ...; name?: ...; parent?: ... }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: ...; extension?: ...; name?: ...; parent?: ...; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of changes.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The source repository,target repository, or commit does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/commits`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/commits": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                from?: string;
                fromRepo?: string;
                limit?: number;
                start?: number;
                to?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
                            authorTimestamp?: number;
                            committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
                            committerTimestamp?: number;
                            displayId?: string;
                            id?: string;
                            message?: string;
                            parents?: readonly (...)[];
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { from?: string; fromRepo?: string; limit?: number; start?: number; to?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; authorTimestamp?: number; committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get accessible commits
Description
Gets the commits accessible from the from commit but not in the to commit.
If either the <code>from</code> or <code>to</code> commit are not specified, they will be replaced by the default branch of their containing repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { from?: string; fromRepo?: string; limit?: number; start?: number; to?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { from?: string; fromRepo?: string; limit?: number; start?: number; to?: string; }
 - Optional Readonlyfrom?: string
 Description
 the source commit (can be a partial/full commit ID or qualified/unqualified ref name)
 - Optional ReadonlyfromRepo?: string
 Description
 an optional parameter specifying the source repository containing the source commit if that commit is not present in the current repository; the repository can be specified by either its ID fromRepo=42 or by its project key plus its repo slug separated by a slash: fromRepo=projectKey/repoSlug
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlyto?: string
 Description
 the target commit (can be a partial/full commit ID or qualified/unqualified ref name)
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; authorTimestamp?: number; committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; authorTimestamp?: number; committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of commits.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The source repository,target repository, or commit does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/diff-stats-summary{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/diff-stats-summary{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { path: string; projectKey: string; repositorySlug: string };
            query?: {
                from?: string;
                fromRepo?: string;
                srcPath?: string;
                to?: string;
                whitespace?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        binary?: boolean;
                        destination?: {
                            components?: readonly string[];
                            extension?: string;
                            name?: string;
                            parent?: string;
                        };
                        hunks?: readonly {
                            context?: string;
                            destinationLine?: number;
                            destinationSpan?: number;
                            segments?: readonly (...)[];
                            sourceLine?: number;
                            sourceSpan?: number;
                            truncated?: boolean;
                        }[];
                        lineComments?: readonly {
                            anchor?: {
                                diffType?: ...;
                                fileType?: ...;
                                fromHash?: ...;
                                line?: ...;
                                lineType?: ...;
                                multilineMarker?: ...;
                                path?: ...;
                                pullRequest?: ...;
                                srcPath?: ...;
                                toHash?: ...;
                            };
                            anchored?: boolean;
                            author?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            parent?: {
                                anchor?: ...;
                                anchored?: ...;
                                author?: ...;
                                comments?: ...;
                                createdDate?: ...;
                                html?: ...;
                                id?: ...;
                                pending?: ...;
                                properties?: ...;
                                reply?: ...;
                                resolvedDate?: ...;
                                resolver?: ...;
                                severity?: ...;
                                state?: ...;
                                text?: ...;
                                threadResolved?: ...;
                                threadResolvedDate?: ...;
                                threadResolver?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            };
                            pending?: boolean;
                            properties?: Record<(...), (...)>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                        properties?: Record<string, unknown>;
                        source?: {
                            components?: readonly string[];
                            extension?: string;
                            name?: string;
                            parent?: string;
                        };
                        truncated?: boolean;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { from?: string; fromRepo?: string; srcPath?: string; to?: string; whitespace?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Retrieve the diff stats summary between commits
Description
Retrieve the diff stats summary of the changes available in the from commit but not in the to commit.
If either the <code> from</code> or <code> to</code> commit are not specified, they will be replaced by the default branch of their containing repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { from?: string; fromRepo?: string; srcPath?: string; to?: string; whitespace?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { path: string; projectKey: string; repositorySlug: string }
 - Readonlypath: string
 Description
 the path to the file to diff (optional)
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { from?: string; fromRepo?: string; srcPath?: string; to?: string; whitespace?: string; }
 - Optional Readonlyfrom?: string
 Description
 the source commit (can be a partial/full commit ID or qualified/unqualified ref name)
 - Optional ReadonlyfromRepo?: string
 Description
 an optional parameter specifying the source repository containing the source commit if that commit is not present in the current repository; the repository can be specified by either its ID fromRepo=42 or by its project key plus its repo slug separated by a slash: fromRepo=projectKey/repoSlug
 - Optional ReadonlysrcPath?: string
 Description
 source path
 - Optional Readonlyto?: string
 Description
 the target commit (can be a partial/full commit ID or qualified/unqualified ref name)
 - Optional Readonlywhitespace?: string
 Description
 an optional whitespace flag which can be set to ignore-all
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The diff stats summary for the changes.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The source repository,target repository, or commit does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/diff{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/compare/diff{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { path: string; projectKey: string; repositorySlug: string };
            query?: {
                contextLines?: string;
                from?: string;
                fromRepo?: string;
                srcPath?: string;
                to?: string;
                whitespace?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        binary?: boolean;
                        destination?: {
                            components?: readonly string[];
                            extension?: string;
                            name?: string;
                            parent?: string;
                        };
                        hunks?: readonly {
                            context?: string;
                            destinationLine?: number;
                            destinationSpan?: number;
                            segments?: readonly (...)[];
                            sourceLine?: number;
                            sourceSpan?: number;
                            truncated?: boolean;
                        }[];
                        lineComments?: readonly {
                            anchor?: {
                                diffType?: ...;
                                fileType?: ...;
                                fromHash?: ...;
                                line?: ...;
                                lineType?: ...;
                                multilineMarker?: ...;
                                path?: ...;
                                pullRequest?: ...;
                                srcPath?: ...;
                                toHash?: ...;
                            };
                            anchored?: boolean;
                            author?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            parent?: {
                                anchor?: ...;
                                anchored?: ...;
                                author?: ...;
                                comments?: ...;
                                createdDate?: ...;
                                html?: ...;
                                id?: ...;
                                pending?: ...;
                                properties?: ...;
                                reply?: ...;
                                resolvedDate?: ...;
                                resolver?: ...;
                                severity?: ...;
                                state?: ...;
                                text?: ...;
                                threadResolved?: ...;
                                threadResolvedDate?: ...;
                                threadResolver?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            };
                            pending?: boolean;
                            properties?: Record<(...), (...)>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                        properties?: Record<string, unknown>;
                        source?: {
                            components?: readonly string[];
                            extension?: string;
                            name?: string;
                            parent?: string;
                        };
                        truncated?: boolean;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { contextLines?: string; from?: string; fromRepo?: string; srcPath?: string; to?: string; whitespace?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get diff between commits
Description
Gets a diff of the changes available in the from commit but not in the to commit.
If either the <code> from</code> or <code> to</code> commit are not specified, they will be replaced by the default branch of their containing repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { contextLines?: string; from?: string; fromRepo?: string; srcPath?: string; to?: string; whitespace?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { path: string; projectKey: string; repositorySlug: string }
 - Readonlypath: string
 Description
 the path to the file to diff (optional)
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { contextLines?: string; from?: string; fromRepo?: string; srcPath?: string; to?: string; whitespace?: string; }
 - Optional ReadonlycontextLines?: string
 Description
 an optional number of context lines to include around each added or removed lines in the diff
 - Optional Readonlyfrom?: string
 Description
 the source commit (can be a partial/full commit ID or qualified/unqualified ref name)
 - Optional ReadonlyfromRepo?: string
 Description
 an optional parameter specifying the source repository containing the source commit if that commit is not present in the current repository; the repository can be specified by either its ID fromRepo=42 or by its project key plus its repo slug separated by a slash: fromRepo=projectKey/repoSlug
 - Optional ReadonlysrcPath?: string
 Description
 source path
 - Optional Readonlyto?: string
 Description
 the target commit (can be a partial/full commit ID or qualified/unqualified ref name)
 - Optional Readonlywhitespace?: string
 Description
 an optional whitespace flag which can be set to ignore-all
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The diff of the changes.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The source repository,target repository, or commit does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/contributing`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/contributing": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                at?: string;
                hardwrap?: string;
                htmlEscape?: string;
                includeHeadingId?: string;
                markup?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository contributing guidelines
Description
Retrieves the contributing guidelines for the repository, if they've been defined.
This checks the repository for a CONTRIBUTING file, optionally with an md or txt extension, and, if found, streams it. By default, the raw content of the file is streamed. Appending <code>?markup</code> to the URL will stream an HTML-rendered version instead. The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }
 - Optional Readonlyat?: string
 Description
 A specific commit or ref to retrieve the guidelines at, or the default branch if not specified
 - Optional Readonlyhardwrap?: string
 Description
 (Optional) Whether the markup implementation should convert newlines to breaks. If not specified, the value of the markup.render.hardwrap property, which is true by default, will be used
 - Optional ReadonlyhtmlEscape?: string
 Description
 (Optional) true if HTML should be escaped in the input markup, false otherwise. If not specified, the value of the markup.render.html.escape property, which is true by default, will be used
 - Optional ReadonlyincludeHeadingId?: string
 Description
 (Optional) true if headings should contain an ID based on the heading content. If not specified, the value of the markup.render.headerids property, which is false by default, will be used
 - Optional Readonlymarkup?: string
 Description
 If present or "true", triggers the raw content to be markup-rendered and returned as HTML; otherwise, if not specified, or any value other than "true", the content is streamed without markup
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The contributing guidelines for the repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to read the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/default-branch`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/default-branch": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        displayId?: string;
                        id?: string;
                        type?: "BRANCH"
                        | "TAG";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    default?: boolean;
                    displayId?: string;
                    id?: string;
                    latestChangeset?: string;
                    latestCommit?: string;
                    type?: unknown;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { displayId?: string; id?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository default branch
Description
Retrieves the repository's configured default branch.
Every repository has a configured default branch, but that branch may not actually exist in the repository. For example, a newly-created repository will have a configured default branch even though no branches have been pushed yet. The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { displayId?: string; id?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { displayId?: string; id?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The configured default branch for the repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to read the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist, or its configured default branch does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update default branch for repository
Description
Update the default branch of a repository.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; }
 Description
 The branch to set as default
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The default branch was updated.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user does not have permission to modify the default branch.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/diff`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/diff": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                contextLines?: string;
                since?: string;
                srcPath?: string;
                until?: string;
                whitespace?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { contextLines?: string; since?: string; srcPath?: string; until?: string; whitespace?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get raw diff for path
Description
Stream the raw diff between two provided revisions.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { contextLines?: string; since?: string; srcPath?: string; until?: string; whitespace?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { contextLines?: string; since?: string; srcPath?: string; until?: string; whitespace?: string; }
 - Optional ReadonlycontextLines?: string
 Description
 The number of context lines to include around added/removed lines in the diff
 - Optional Readonlysince?: string
 Description
 The base revision to diff from. If omitted the parent revision of the until revision is used
 - Optional ReadonlysrcPath?: string
 Description
 The source path for the file, if it was copied, moved or renamed
 - Optional Readonlyuntil?: string
 Description
 The target revision to diff to (required)
 - Optional Readonlywhitespace?: string
 Description
 Optional whitespace flag which can be set to ignore-all
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A raw diff between two revisions.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The path parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/diff/{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/diff/{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { path: string; projectKey: string; repositorySlug: string };
            query?: {
                contextLines?: string;
                since?: string;
                srcPath?: string;
                until?: string;
                whitespace?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { contextLines?: string; since?: string; srcPath?: string; until?: string; whitespace?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get raw diff for path
Description
Stream the raw diff between two provided revisions.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { contextLines?: string; since?: string; srcPath?: string; until?: string; whitespace?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { path: string; projectKey: string; repositorySlug: string }
 - Readonlypath: string
 Description
 The path to the file which should be diffed (required)
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { contextLines?: string; since?: string; srcPath?: string; until?: string; whitespace?: string; }
 - Optional ReadonlycontextLines?: string
 Description
 The number of context lines to include around added/removed lines in the diff
 - Optional Readonlysince?: string
 Description
 The base revision to diff from. If omitted the parent revision of the until revision is used
 - Optional ReadonlysrcPath?: string
 Description
 The source path for the file, if it was copied, moved or renamed
 - Optional Readonlyuntil?: string
 Description
 The target revision to diff to (required)
 - Optional Readonlywhitespace?: string
 Description
 Optional whitespace flag which can be set to ignore-all
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A raw diff between two revisions.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The until parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/files`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/files": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { at?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly unknown[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly unknown[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get files in directory
Description
Retrieve a page of files from particular directory of a repository. The search is done recursively, so all files from any sub-directory of the specified directory will be returned.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string; limit?: number; start?: number }
 - Optional Readonlyat?: string
 Description
 The commit ID or ref (e.g. a branch or tag) to list the files at. If not specified the default branch will be used instead.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly unknown[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly unknown[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of files.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The path parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The path requested does not exist at the supplied commit.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/files/{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/files/{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { path: string; projectKey: string; repositorySlug: string };
            query?: { at?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly unknown[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { at?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly unknown[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get files in directory
Description
Retrieve a page of files from particular directory of a repository. The search is done recursively, so all files from any sub-directory of the specified directory will be returned.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { at?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { path: string; projectKey: string; repositorySlug: string }
 - Readonlypath: string
 Description
 The directory to list files for.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string; limit?: number; start?: number }
 - Optional Readonlyat?: string
 Description
 The commit ID or ref (e.g. a branch or tag) to list the files at. If not specified the default branch will be used instead.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly unknown[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly unknown[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of files.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The path requested is not a directory at the supplied commit.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The path requested does not exist at the supplied commit.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/forks`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/forks": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            origin?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            partition?: number;
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            public?: boolean;
                            relatedLinks?: Record<(...), (...)>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository forks
Description
Retrieve repositories which have been forked from this one. Unlike #getRelatedRepositories(Repository, PageRequest) related repositories, this only looks at a given repository's direct forks. If those forks have themselves been the origin of more forks, such "grandchildren" repositories will not be retrieved.
Only repositories to which the authenticated user has REPO_READ permission will be included, even if other repositories have been forked from this one.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of repositories related to the request repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to see the request repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/hook-scripts`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/hook-scripts": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            scope?: { resourceId?: ...; type?: ... };
                            script?: {
                                createdDate?: ...;
                                description?: ...;
                                id?: ...;
                                name?: ...;
                                pluginKey?: ...;
                                type?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            };
                            triggerIds?: readonly (...)[];
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { scope?: { resourceId?: ...; type?: ... }; script?: { createdDate?: ...; description?: ...; id?: ...; name?: ...; pluginKey?: ...; type?: ...; updatedDate?: ...; version?: ...; }; triggerIds?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get hook scripts
Description
Return a page of hook scripts configured for the specified repository.
This endpoint requires **REPO_ADMIN** permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { scope?: { resourceId?: ...; type?: ... }; script?: { createdDate?: ...; description?: ...; id?: ...; name?: ...; pluginKey?: ...; type?: ...; updatedDate?: ...; version?: ...; }; triggerIds?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { scope?: { resourceId?: ...; type?: ... }; script?: { createdDate?: ...; description?: ...; id?: ...; name?: ...; pluginKey?: ...; type?: ...; updatedDate?: ...; version?: ...; }; triggerIds?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of hook scripts.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/hook-scripts/{scriptId}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/hook-scripts/{scriptId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string; scriptId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string; scriptId: string };
            query?: undefined;
        };
        requestBody?: {
            content: { "application/json": { triggerIds?: readonly string[] } };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        script?: {
                            createdDate?: string;
                            description?: string;
                            id?: number;
                            name?: string;
                            pluginKey?: string;
                            type?: "POST"
                            | "PRE";
                            updatedDate?: string;
                            version?: number;
                        };
                        triggerIds?: readonly string[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; scriptId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Remove a hook script
Description
Removes the hook script from the set of hook scripts configured to run in the repository.
This endpoint requires **REPO_ADMIN** permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; scriptId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; scriptId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlyscriptId: string
 Description
 The ID of the hook script
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The hook script was successfully deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository slug or hook script ID supplied does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; scriptId: string }; query?: undefined; }; requestBody?: { content: { "application/json": { triggerIds?: readonly string[] } }; }; responses: { "200": { content: { "application/json": { scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; script?: { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; triggerIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create/update a hook script
Description
Creates/updates the hook script configuration for the provided hook script and repository.
This endpoint requires **REPO_ADMIN** permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; scriptId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; scriptId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlyscriptId: string
 Description
 The ID of the hook script
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { triggerIds?: readonly string[] } } }
 Description
 The hook triggers for which the hook script should be run
- Readonlyresponses: { "200": { content: { "application/json": { scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; script?: { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; triggerIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; script?: { createdDate?: string; description?: string; id?: number; name?: string; pluginKey?: string; type?: "POST" | "PRE"; updatedDate?: string; version?: number; }; triggerIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated hook script.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The hook script was not created/updated due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository slug supplied does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/labels`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/labels": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { name?: string } };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: { content: { "application/json": { name?: string } } };
        responses: {
            "200": {
                content: { "application/json": { name?: string } };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { name?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository labels
Description
Get all labels applied to the given repository.
The authenticated user must have REPO_READ permission for the specified repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { name?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { name?: string } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The applied label.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the labels.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { name?: string } } }; responses: { "200": { content: { "application/json": { name?: string } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add repository label
Description
Applies a label to the repository.
The authenticated user must have REPO_ADMIN permission for the specified repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { name?: string } } }
 Description
 The label to apply
- Readonlyresponses: { "200": { content: { "application/json": { name?: string } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { name?: string } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The applied label.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A validation error prevented the label from being created or applied. Possible validation errors include: The name of the label contains uppercase characters, the name is smaller than 3 characters or longer than 50 characters, the label contains other characters than a-z 0-9 and - or the label is already applied to the given repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to apply a label.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/labels/{labelName}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/labels/{labelName}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { labelName: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { labelName: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Remove repository label
Description
Remove label that is applied to the given repository.
The authenticated user must have REPO_ADMIN permission for the specified repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { labelName: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { labelName: string; projectKey: string; repositorySlug: string }
 - ReadonlylabelName: string
 Description
 The label to remove
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the label is no longer associated to the repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to remove the label.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/last-modified`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/last-modified": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { at?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        files?: {
                            latestCommit?: {
                                author?: (...)
                                | (...);
                                authorTimestamp?: (...) | (...);
                                committer?: (...) | (...);
                                committerTimestamp?: (...) | (...);
                                displayId?: (...) | (...);
                                id?: (...) | (...);
                                message?: (...) | (...);
                                parents?: (...) | (...);
                            };
                            pomXml?: {
                                author?: (...)
                                | (...);
                                authorTimestamp?: (...) | (...);
                                committer?: (...) | (...);
                                committerTimestamp?: (...) | (...);
                                displayId?: (...) | (...);
                                id?: (...) | (...);
                                message?: (...) | (...);
                                parents?: (...) | (...);
                            };
                            readmeMd?: {
                                author?: (...)
                                | (...);
                                authorTimestamp?: (...) | (...);
                                committer?: (...) | (...);
                                committerTimestamp?: (...) | (...);
                                displayId?: (...) | (...);
                                id?: (...) | (...);
                                message?: (...) | (...);
                                parents?: (...) | (...);
                            };
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { files?: { latestCommit?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; pomXml?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; readmeMd?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Stream files
Description
Streams files from the repository's root with the last commit to modify each file. Commit modifications are traversed starting from the at commit or, if not specified, from the tip of the default branch.
Unless the repository is public, the authenticated user must have REPO_READ access to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { at?: string }
 - Optional Readonlyat?: string
 Description
 The commit to use as the starting point when listing files and calculating modifications
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { files?: { latestCommit?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; pomXml?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; readmeMd?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { files?: { latestCommit?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; pomXml?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; readmeMd?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A map of files to the last commit that modified them, and the latest commit to the repository (by nature, any commit to a repository modifies its root).
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No at commit was specified. When streaming modifications, an explicit starting commit must be supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist or does not contain the at commit.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/last-modified/{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/last-modified/{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { path: string; projectKey: string; repositorySlug: string };
            query?: { at?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        files?: {
                            latestCommit?: {
                                author?: (...)
                                | (...);
                                authorTimestamp?: (...) | (...);
                                committer?: (...) | (...);
                                committerTimestamp?: (...) | (...);
                                displayId?: (...) | (...);
                                id?: (...) | (...);
                                message?: (...) | (...);
                                parents?: (...) | (...);
                            };
                            pomXml?: {
                                author?: (...)
                                | (...);
                                authorTimestamp?: (...) | (...);
                                committer?: (...) | (...);
                                committerTimestamp?: (...) | (...);
                                displayId?: (...) | (...);
                                id?: (...) | (...);
                                message?: (...) | (...);
                                parents?: (...) | (...);
                            };
                            readmeMd?: {
                                author?: (...)
                                | (...);
                                authorTimestamp?: (...) | (...);
                                committer?: (...) | (...);
                                committerTimestamp?: (...) | (...);
                                displayId?: (...) | (...);
                                id?: (...) | (...);
                                message?: (...) | (...);
                                parents?: (...) | (...);
                            };
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { at?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { files?: { latestCommit?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; pomXml?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; readmeMd?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Stream files with last modified commit in path
Description
Streams files in the requested path with the last commit to modify each file. Commit modifications are traversed starting from the at commit or, if not specified, from the tip of the default branch.
Unless the repository is public, the authenticated user must have REPO_READ access to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { at?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { path: string; projectKey: string; repositorySlug: string }
 - Readonlypath: string
 Description
 The path within the repository whose files should be streamed
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: { at?: string }
 - Optional Readonlyat?: string
 Description
 The commit to use as the starting point when listing files and calculating modifications
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { files?: { latestCommit?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; pomXml?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; readmeMd?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { files?: { latestCommit?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; pomXml?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; readmeMd?: { author?: (...) | (...); authorTimestamp?: (...) | (...); committer?: (...) | (...); committerTimestamp?: (...) | (...); displayId?: (...) | (...); id?: (...) | (...); message?: (...) | (...); parents?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A map of files to the last commit that modified them, and the latest commit to update the requested path.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No at commit was specified. When streaming modifications, an explicit starting commit must be supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist or does not contain the at commit, or the at commit does not contain the requested path.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/license`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/license": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                at?: string;
                hardwrap?: string;
                htmlEscape?: string;
                includeHeadingId?: string;
                markup?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository license
Description
Retrieves the license for the repository, if it's been defined.
This checks the repository for a <pre>LICENSE</pre> file, optionally with an <pre>md</pre> or <pre>txt</pre>extension, and, if found, streams it. By default, the raw content of the file is streamed. Appending <pre>?markup</pre> to the URL will stream an HTML-rendered version instead. The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }
 - Optional Readonlyat?: string
 Description
 A specific commit or ref to retrieve the guidelines at, or the default branch if not specified
 - Optional Readonlyhardwrap?: string
 Description
 (Optional) Whether the markup implementation should convert newlines to breaks. If not specified, the value of the markup.render.hardwrap property, which is true by default, will be used
 - Optional ReadonlyhtmlEscape?: string
 Description
 (Optional) true if HTML should be escaped in the input markup, false otherwise. If not specified, the value of the markup.render.html.escape property, which is true by default, will be used
 - Optional ReadonlyincludeHeadingId?: string
 Description
 (Optional) true if headings should contain an ID based on the heading content. If not specified, the value of the markup.render.headerids property, which is false by default, will be used
 - Optional Readonlymarkup?: string
 Description
 If present or "true", triggers the raw content to be markup-rendered and returned as HTML; otherwise, if not specified, or any value other than "true", the content is streamed without markup
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The license for the repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to read the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/participants`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/participants": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                direction?: string;
                filter?: string;
                limit?: number;
                role?: string;
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { direction?: string; filter?: string; limit?: number; role?: string; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Search pull request participants
Description
Retrieve a page of participant users for all the pull requests to or from the specified repository.
Optionally clients can specify following filters.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { direction?: string; filter?: string; limit?: number; role?: string; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { direction?: string; filter?: string; limit?: number; role?: string; start?: number; }
 - Optional Readonlydirection?: string
 Description
 (optional), Defaults to INCOMING) the direction relative to the specified repository. Either INCOMING or OUTGOING.
 - Optional Readonlyfilter?: string
 Description
 (optional) Return only users, whose username, name or email address contain the filter value
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyrole?: string
 Description
 (optional) The role associated with the pull request participant. This must be one of AUTHOR, REVIEWER, or PARTICIPANT
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of users that match the search criteria.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/patch`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/patch": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { allAncestors?: string; since?: string; until?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { allAncestors?: string; since?: string; until?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get patch content at revision
Description
Retrieve the patch content for a repository at a specified revision.
Cache headers are added to the response (only if full commit hashes are used, not in the case of short hashes). The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { allAncestors?: string; since?: string; until?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { allAncestors?: string; since?: string; until?: string }
 - Optional ReadonlyallAncestors?: string
 Description
 indicates whether or not to generate a patch which includes all the ancestors of the 'until' revision. If true, the value provided by 'since' is ignored.
 - Optional Readonlysince?: string
 Description
 The base revision from which to generate the patch. This is only applicable when 'allAncestors' is false. If omitted the patch will represent one single commit, the 'until'.
 - Optional Readonlyuntil?: string
 Description
 The target revision from which to generate the patch (required)
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The patch contents from a repository.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The until parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { group?: string; user?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { group?: string; user?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Revoke all repository permissions for users and groups
Description
Revoke all permissions for the specified repository for the given groups and users.
The authenticated user must have PROJECT_ADMIN permission for the specified repository or a higher global permission to call this resource. In addition, a user may not revoke a group's permission if their own permission would be revoked as a result, nor may they revoke their own permission unless they have a global permission that already implies that permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { group?: string; user?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { group?: string; user?: string }
 - Optional Readonlygroup?: string
 Description
 The names of the groups
 - Optional Readonlyuser?: string
 Description
 The names of the users
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 All repository permissions were revoked from the users and groups for the specified repository.
 - Readonly400: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 No permissions were revoked because the request was invalid. No users or groups were provided.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not an administrator for the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist, or one or more of the users or groups provided does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would revoke the currently authenticated user's permission on the repository.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/groups`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/groups": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query: { name: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { filter?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly { group?: { name?: ... }; permission?: string }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query: {
                name: readonly string[];
                permission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE";
            };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query: { name: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Revoke group repository permission
Description
Revoke all permissions for the specified repository for a group.
The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource. In addition, a user may not revoke a group's permissions if it will reduce their own permission level.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query: { name: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Readonlyquery: { name: string }
 - Readonlyname: string
 Description
 The name of the group.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 All repository permissions were revoked from the group for the specified repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a repository administrator for the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would reduce the currently authenticated user's permission level.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { group?: { name?: ... }; permission?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get groups with permission to repository
Description
Retrieve a page of groups that have been granted at least one permission for the specified repository.
The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only group names containing the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { group?: { name?: ... }; permission?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { group?: { name?: ... }; permission?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of groups and their highest permissions for the specified repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a repository administrator for the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query: { name: readonly string[]; permission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"; }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update group repository permission
Description
Promote or demote a group's permission level for the specified repository. Available repository permissions are:
- REPO_READ - REPO_WRITE - REPO_ADMIN See the <a href="https://confluence.atlassian.com/display/BitbucketServer/Using+repository+permissions">Bitbucket Data Center documentation</a> for a detailed explanation of what each permission entails. The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource. In addition, a user may not demote a group's permission level if their own permission level would be reduced as a result.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query: { name: readonly string[]; permission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Readonlyquery: { name: readonly string[]; permission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"; }
 - Readonlyname: readonly string[]
 Description
 The names of the groups.
 - Readonlypermission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"
 Description
 The permission to grant
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The requested permission was granted.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed or the specified permission does not exist.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a repository administrator for the specified repository.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would reduce the currently authenticated user's permission level.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/groups/none`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/groups/none": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { filter?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly { deletable?: boolean; name?: string }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { deletable?: boolean; name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get groups without repository permission
Description
Retrieve a page of groups that have no granted permissions for the specified repository.
The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only group names containing the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { deletable?: boolean; name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { deletable?: boolean; name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of groups that have not been granted any permissions for the specified repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a repository administrator for the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/search`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/search": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { filterText?: string; permission?: string; type?: string };
        };
        requestBody?: undefined;
        responses: {
            default: {
                content: { "application/json;charset=UTF-8": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filterText?: string; permission?: string; type?: string }; }; requestBody?: undefined; responses: { default: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }; }; }
Search repository permissions
Description
Search direct and implied permissions of users and groups. This endpoint returns a superset of the results returned by the /users and /groups endpoints because it allows filtering by project and global permissions too.
The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project/global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filterText?: string; permission?: string; type?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { filterText?: string; permission?: string; type?: string }
 - Optional ReadonlyfilterText?: string
 Description
 Name of the user or group to filter the name of
 - Optional Readonlypermission?: string
 Description
 Permissions to filter by. See the permissions documentationfor a detailed explanation of what each permission entails. This parameter can be specified multiple times to filter by more than one permission, and can contain repository, project, and global permissions.
 - Optional Readonlytype?: string
 Description
 Type of entity (user or group)Valid entity types are:
 - USER- GROUP
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { default: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonlydefault: { content: { "application/json;charset=UTF-8": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 default response
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/users`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/users": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query: { name: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { filter?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            permission?: | "ADMIN"
                            | "LICENSED_USER"
                            | "PROJECT_ADMIN"
                            | "PROJECT_CREATE"
                            | "PROJECT_READ"
                            | "PROJECT_VIEW"
                            | "PROJECT_WRITE"
                            | "REPO_ADMIN"
                            | "REPO_CREATE"
                            | "REPO_READ"
                            | "REPO_WRITE"
                            | "SYS_ADMIN"
                            | "USER_ADMIN";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query: {
                name: readonly string[];
                permission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE";
            };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query: { name: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Revoke user repository permission
Description
Revoke all permissions for the specified repository for a user.
The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource. In addition, a user may not revoke their own repository permissions if they do not have a higher project or global permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query: { name: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Readonlyquery: { name: string }
 - Readonlyname: string
 Description
 The name of the user.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 All repository permissions were revoked from the user for the specified repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a repository administrator for the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would reduce the currently authenticated user's permission level.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get users with permission to repository
Description
Retrieve a page of users that have been granted at least one permission for the specified repository.
The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only user names containing the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of users and their highest permissions for the specified repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a repository administrator for the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query: { name: readonly string[]; permission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"; }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update user repository permission
Description
Promote or demote a user's permission level for the specified repository. Available repository permissions are:
- REPO_READ</li>- REPO_WRITE</li>- REPO_ADMIN</li></ul>See the <a href="https://confluence.atlassian.com/display/BitbucketServer/Using+repository+permissions">Bitbucket Data Center documentation</a> for a detailed explanation of what each permission entails. The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource. In addition, a user may not reduce their own permission level unless they have a project or global permission that already implies that permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query: { name: readonly string[]; permission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Readonlyquery: { name: readonly string[]; permission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"; }
 - Readonlyname: readonly string[]
 Description
 The names of the users.
 - Readonlypermission: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"
 Description
 The permission to grant
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The requested permission was granted.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed or the specified permission does not exist.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a repository administrator for the specified repository.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The action was disallowed as it would reduce the currently authenticated user's permission level.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/users/none`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/permissions/users/none": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { filter?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get users without repository permission
Description
Retrieve a page of licensed users that have no granted permissions for the specified repository.
The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { filter?: string; limit?: number; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only user names containing the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of users that have not been granted any permissions for the specified repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a repository administrator for the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                at?: string;
                direction?: string;
                draft?: string;
                filterText?: string;
                limit?: number;
                order?: string;
                start?: number;
                state?: string;
                withAttributes?: string;
                withProperties?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            closed?: boolean;
                            closedDate?: number;
                            createdDate?: number;
                            description?: string;
                            descriptionAsHtml?: string;
                            draft?: boolean;
                            fromRef?: {
                                displayId?: ...;
                                id?: ...;
                                latestCommit?: ...;
                                repository?: ...;
                                type?: ...;
                            };
                            htmlDescription?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            locked?: boolean;
                            open?: boolean;
                            participants?: readonly (...)[];
                            reviewers?: readonly (...)[];
                            state?: "DECLINED" | "MERGED" | "OPEN";
                            title?: string;
                            toRef?: {
                                displayId?: ...;
                                id?: ...;
                                latestCommit?: ...;
                                repository?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    closed?: boolean;
                    closedDate?: number;
                    createdDate?: number;
                    description?: string;
                    descriptionAsHtml?: string;
                    draft?: boolean;
                    fromRef?: {
                        displayId?: string;
                        id?: string;
                        latestCommit?: string;
                        repository?: {
                            archived?: (...)
                            | (...)
                            | (...);
                            defaultBranch?: (...) | (...);
                            description?: (...) | (...);
                            forkable?: (...) | (...) | (...);
                            hierarchyId?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            origin?: (...) | (...);
                            partition?: (...) | (...);
                            project?: (...) | (...);
                            public?: (...) | (...) | (...);
                            relatedLinks?: (...) | (...);
                            scmId?: (...) | (...);
                            scope?: (...) | (...);
                            slug?: (...) | (...);
                            state?: (...) | (...) | (...) | (...) | (...);
                            statusMessage?: (...) | (...);
                        };
                        type?: "BRANCH"
                        | "TAG";
                    };
                    htmlDescription?: string;
                    id?: number;
                    links?: Record<string, unknown>;
                    locked?: boolean;
                    open?: boolean;
                    participants?: readonly {
                        approved?: boolean;
                        lastReviewedCommit?: string;
                        role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
                        status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                        user?: {
                            active?: ...;
                            avatarUrl?: ...;
                            displayName?: ...;
                            emailAddress?: ...;
                            id?: ...;
                            links?: ...;
                            name?: ...;
                            slug?: ...;
                            type?: ...;
                        };
                    }[];
                    reviewers?: readonly {
                        approved?: boolean;
                        lastReviewedCommit?: string;
                        role?: "PARTICIPANT"
                        | "REVIEWER"
                        | "AUTHOR";
                        status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                        user?: {
                            active?: ...;
                            avatarUrl?: ...;
                            displayName?: ...;
                            emailAddress?: ...;
                            id?: ...;
                            links?: ...;
                            name?: ...;
                            slug?: ...;
                            type?: ...;
                        };
                    }[];
                    state?: "DECLINED"
                    | "MERGED"
                    | "OPEN";
                    title?: string;
                    toRef?: {
                        displayId?: string;
                        id?: string;
                        latestCommit?: string;
                        repository?: {
                            archived?: (...) | (...) | (...);
                            defaultBranch?: (...) | (...);
                            description?: (...) | (...);
                            forkable?: (...) | (...) | (...);
                            hierarchyId?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            origin?: (...) | (...);
                            partition?: (...) | (...);
                            project?: (...) | (...);
                            public?: (...) | (...) | (...);
                            relatedLinks?: (...) | (...);
                            scmId?: (...) | (...);
                            scope?: (...) | (...);
                            slug?: (...) | (...);
                            state?: (...) | (...) | (...) | (...) | (...);
                            statusMessage?: (...) | (...);
                        };
                        type?: "BRANCH"
                        | "TAG";
                    };
                    updatedDate?: number;
                    version?: number;
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        closed?: boolean;
                        closedDate?: number;
                        createdDate?: number;
                        description?: string;
                        descriptionAsHtml?: string;
                        draft?: boolean;
                        fromRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...)
                                | (...)
                                | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        htmlDescription?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        locked?: boolean;
                        open?: boolean;
                        participants?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        reviewers?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT"
                            | "REVIEWER"
                            | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        state?: "DECLINED"
                        | "MERGED"
                        | "OPEN";
                        title?: string;
                        toRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; direction?: string; draft?: string; filterText?: string; limit?: number; order?: string; start?: number; state?: string; withAttributes?: string; withProperties?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; htmlDescription?: string; id?: number; links?: Record<(...), (...)>; locked?: boolean; open?: boolean; participants?: readonly (...)[]; reviewers?: readonly (...)[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull requests for repository
Description
Retrieve a page of pull requests to or from the specified repository.
The authenticated user must have REPO_READ permission for the specified repository to call this resource. Optionally clients can specify PR participant filters. Each filter has a mandatory username.N parameter, and the optional role.N and approved.N parameters. - username.N - the "root" of a single participant filter, where "N" is a natural number starting from 1. This allows clients to specify multiple participant filters, by providing consecutive filters as username.1, username.2 etc. Note that the filters numbering has to start with 1 and be continuous for all filters to be processed. The total allowed number of participant filters is 10 and all filters exceeding that limit will be dropped. - role.N(optional) the role associated with username.N. This must be one of AUTHOR, REVIEWER, or PARTICIPANT - approved.N (optional) the approved status associated with username.N. That is whether username.N has approved the PR. Either true, or false
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; direction?: string; draft?: string; filterText?: string; limit?: number; order?: string; start?: number; state?: string; withAttributes?: string; withProperties?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string; direction?: string; draft?: string; filterText?: string; limit?: number; order?: string; start?: number; state?: string; withAttributes?: string; withProperties?: string; }
 - Optional Readonlyat?: string
 Description
 (optional) a fully-qualified branch ID to find pull requests to or from, such as refs/heads/master
 - Optional Readonlydirection?: string
 Description
 (optional, defaults to INCOMING) the direction relative to the specified repository. Either INCOMING or OUTGOING.
 - Optional Readonlydraft?: string
 Description
 (optional) If specified, only pull requests matching the supplied draft status will be returned.
 - Optional ReadonlyfilterText?: string
 Description
 (optional) If specified, only pull requests where the title or description contains the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyorder?: string
 Description
 (optional, defaults to NEWEST) the order to return pull requests in, either OLDEST (as in: "oldest first") or NEWEST.
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlystate?: string
 Description
 (optional, defaults to OPEN). Supply ALL to return pull request in any state. If a state is supplied only pull requests in the specified state will be returned. Either OPEN, DECLINED or MERGED.
 - Optional ReadonlywithAttributes?: string
 Description
 (optional) defaults to true, whether to return additional pull request attributes
 - Optional ReadonlywithProperties?: string
 Description
 (optional) defaults to true, whether to return additional pull request properties
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; htmlDescription?: string; id?: number; links?: Record<(...), (...)>; locked?: boolean; open?: boolean; participants?: readonly (...)[]; reviewers?: readonly (...)[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; htmlDescription?: string; id?: number; links?: Record<(...), (...)>; locked?: boolean; open?: boolean; participants?: readonly (...)[]; reviewers?: readonly (...)[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: ...; id?: ...; latestCommit?: ...; repository?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of pull requests that match the search criteria.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; }; responses: { "201": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create pull request
Description
Create a new pull request from a source branch or tag to a target branch. The source and target may be in the same repository, or different ones. (Note that different repositories must belong to the same Repository#getHierarchyId() hierarchy.)
The <code>fromRef</code> may be a branch or a tag. The <code>toRef</code> is required to be a branch. Tags are not allowed as targets because tags are intended to be immutable and should not be changed after they are created. The authenticated user must have REPO_READ permission for the <code>fromRef</code> and <code>toRef</code> repositories to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; }
 Description
 The pull request data
- Readonlyresponses: { "201": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created pull request.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request entity supplied in the request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create a pull request between the two specified repositories.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One of the specified repositories or branches does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One of the following error cases occurred (check the error message for more details):
 - There was a problem resolving one or more reviewers. - The specified branches were the same. - The to branch is already up-to-date with all the commits on the from branch. - A pull request between the two branches already exists. - The to repository is archived.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: { content: { "application/json": { version?: number } } };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        closed?: boolean;
                        closedDate?: number;
                        createdDate?: number;
                        description?: string;
                        descriptionAsHtml?: string;
                        draft?: boolean;
                        fromRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...)
                                | (...)
                                | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        htmlDescription?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        locked?: boolean;
                        open?: boolean;
                        participants?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        reviewers?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT"
                            | "REVIEWER"
                            | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        state?: "DECLINED"
                        | "MERGED"
                        | "OPEN";
                        title?: string;
                        toRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    closed?: boolean;
                    closedDate?: number;
                    createdDate?: number;
                    description?: string;
                    descriptionAsHtml?: string;
                    draft?: boolean;
                    fromRef?: {
                        displayId?: string;
                        id?: string;
                        latestCommit?: string;
                        repository?: {
                            archived?: (...)
                            | (...)
                            | (...);
                            defaultBranch?: (...) | (...);
                            description?: (...) | (...);
                            forkable?: (...) | (...) | (...);
                            hierarchyId?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            origin?: (...) | (...);
                            partition?: (...) | (...);
                            project?: (...) | (...);
                            public?: (...) | (...) | (...);
                            relatedLinks?: (...) | (...);
                            scmId?: (...) | (...);
                            scope?: (...) | (...);
                            slug?: (...) | (...);
                            state?: (...) | (...) | (...) | (...) | (...);
                            statusMessage?: (...) | (...);
                        };
                        type?: "BRANCH"
                        | "TAG";
                    };
                    htmlDescription?: string;
                    id?: number;
                    links?: Record<string, unknown>;
                    locked?: boolean;
                    open?: boolean;
                    participants?: readonly {
                        approved?: boolean;
                        lastReviewedCommit?: string;
                        role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
                        status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                        user?: {
                            active?: ...;
                            avatarUrl?: ...;
                            displayName?: ...;
                            emailAddress?: ...;
                            id?: ...;
                            links?: ...;
                            name?: ...;
                            slug?: ...;
                            type?: ...;
                        };
                    }[];
                    reviewers?: readonly {
                        approved?: boolean;
                        lastReviewedCommit?: string;
                        role?: "PARTICIPANT"
                        | "REVIEWER"
                        | "AUTHOR";
                        status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                        user?: {
                            active?: ...;
                            avatarUrl?: ...;
                            displayName?: ...;
                            emailAddress?: ...;
                            id?: ...;
                            links?: ...;
                            name?: ...;
                            slug?: ...;
                            type?: ...;
                        };
                    }[];
                    state?: "DECLINED"
                    | "MERGED"
                    | "OPEN";
                    title?: string;
                    toRef?: {
                        displayId?: string;
                        id?: string;
                        latestCommit?: string;
                        repository?: {
                            archived?: (...) | (...) | (...);
                            defaultBranch?: (...) | (...);
                            description?: (...) | (...);
                            forkable?: (...) | (...) | (...);
                            hierarchyId?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            origin?: (...) | (...);
                            partition?: (...) | (...);
                            project?: (...) | (...);
                            public?: (...) | (...) | (...);
                            relatedLinks?: (...) | (...);
                            scmId?: (...) | (...);
                            scope?: (...) | (...);
                            slug?: (...) | (...);
                            state?: (...) | (...) | (...) | (...) | (...);
                            statusMessage?: (...) | (...);
                        };
                        type?: "BRANCH"
                        | "TAG";
                    };
                    updatedDate?: number;
                    version?: number;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        closed?: boolean;
                        closedDate?: number;
                        createdDate?: number;
                        description?: string;
                        descriptionAsHtml?: string;
                        draft?: boolean;
                        fromRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...)
                                | (...)
                                | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        htmlDescription?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        locked?: boolean;
                        open?: boolean;
                        participants?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        reviewers?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT"
                            | "REVIEWER"
                            | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        state?: "DECLINED"
                        | "MERGED"
                        | "OPEN";
                        title?: string;
                        toRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { version?: number } } }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete pull request
Description
Deletes a pull request.
To call this resource, users must be authenticated and have permission to view the pull request. Additionally, they must: - be the pull request author, if the system is configured to allow authors to delete their own pull requests (this is the default) OR - have repository administrator permission for the repository the pull request is targeting A body containing the version of the pull request must be provided with this request. `{ "version": 1 }`
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { version?: number } } }
 Description
 A body containing the version of the pull request
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The pull request was deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Deleting pull requests isn't supported on archived repositories.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request
Description
Retrieve a pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; }; responses: { "200": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update pull request metadata
Description
Update the title, description, reviewers, destination branch or draft status of an existing pull request.
**Note:** the reviewers list may be updated using this resource. However the author and participants list may not. The authenticated user must either: - be the author of the pull request and have the REPO_READ permission for the repository that this pull request targets; or - have the REPO_WRITE permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; }
 Description
 The updated pull request
- Readonlyresponses: { "200": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated pull request.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One of the following error cases occurred (check the error message for more details):
 - The request tried to modify the author or participants. - The pull request's version attribute was not specified. - A reviewer's username was not specified. - The toRef ID value was incorrectly left blank
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One of the specified repositories or branches does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One of the following error cases occurred (check the error message for more details):
 - The specified version is out of date. - One of the reviewers could not be added to the pull request. - If updating the destination branch: - There is already an open pull request with an identical to branch - The from and new to branch are the same - The new destination branch up-to-date is up-to-date with all of changes from the from branch, resulting in a pull request with nothing to merge - The to repository is archived.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}.diff`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}.diff": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: { contextLines?: string; whitespace?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "text/plain": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: { "text/html": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: { "text/html": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { contextLines?: string; whitespace?: string }; }; requestBody?: undefined; responses: { "200": { content: { "text/plain": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "text/html": unknown }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "text/html": unknown }; headers: Readonly<Record<string, unknown>>; }; }; }
Stream raw pull request diff
Description
Streams the raw diff for a pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { contextLines?: string; whitespace?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { contextLines?: string; whitespace?: string }
 - Optional ReadonlycontextLines?: string
 Description
 The number of context lines to include around added/removed lines in the diff
 - Optional Readonlywhitespace?: string
 Description
 optional whitespace flag which can be set to ignore-all
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "text/plain": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "text/html": unknown }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "text/html": unknown }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "text/plain": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A raw diff for the specified pull request.
 - Readonly400: { content: { "text/html": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified pull request.
 - Readonly404: { content: { "text/html": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}.patch`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}.patch": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Stream pull request as patch
Description
Streams a patch representing a pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A patch representing the specified pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to access the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/activities`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/activities": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: {
                fromId?: string;
                fromType?: string;
                limit?: number;
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            action?: | "DECLINED"
                            | "MERGED"
                            | "APPROVED"
                            | "UNAPPROVED"
                            | "AUTO_MERGE_CANCELLED"
                            | "AUTO_MERGE_REQUESTED"
                            | "COMMENTED"
                            | "DELETED"
                            | "OPENED"
                            | "REOPENED"
                            | "RESCOPED"
                            | "REVIEW_COMMENTED"
                            | "REVIEW_DISCARDED"
                            | "REVIEW_FINISHED"
                            | "REVIEWED"
                            | "UPDATED";
                            createdDate?: number;
                            id?: number;
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { fromId?: string; fromType?: string; limit?: number; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { action?: | "DECLINED" | "MERGED" | "APPROVED" | "UNAPPROVED" | "AUTO_MERGE_CANCELLED" | "AUTO_MERGE_REQUESTED" | "COMMENTED" | "DELETED" | "OPENED" | "REOPENED" | "RESCOPED" | "REVIEW_COMMENTED" | "REVIEW_DISCARDED" | "REVIEW_FINISHED" | "REVIEWED" | "UPDATED"; createdDate?: number; id?: number; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request activity
Description
Retrieve a page of activity associated with a pull request.
Activity items include comments, approvals, rescopes (i.e. adding and removing of commits), merges and more. Different types of activity items may be introduced in newer versions of Stash or by user installed plugins, so clients should be flexible enough to handle unexpected entity shapes in the returned page. The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { fromId?: string; fromType?: string; limit?: number; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { fromId?: string; fromType?: string; limit?: number; start?: number }
 - Optional ReadonlyfromId?: string
 Description
 (optional) the ID of the activity item to use as the first item in the returned page
 - Optional ReadonlyfromType?: string
 Description
 (required if fromId is present) the type of the activity item specified by fromId (either COMMENT or ACTIVITY)
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { action?: | "DECLINED" | "MERGED" | "APPROVED" | "UNAPPROVED" | "AUTO_MERGE_CANCELLED" | "AUTO_MERGE_REQUESTED" | "COMMENTED" | "DELETED" | "OPENED" | "REOPENED" | "RESCOPED" | "REVIEW_COMMENTED" | "REVIEW_DISCARDED" | "REVIEW_FINISHED" | "REVIEWED" | "UPDATED"; createdDate?: number; id?: number; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { action?: | "DECLINED" | "MERGED" | "APPROVED" | "UNAPPROVED" | "AUTO_MERGE_CANCELLED" | "AUTO_MERGE_REQUESTED" | "COMMENTED" | "DELETED" | "OPENED" | "REOPENED" | "RESCOPED" | "REVIEW_COMMENTED" | "REVIEW_DISCARDED" | "REVIEW_FINISHED" | "REVIEWED" | "UPDATED"; createdDate?: number; id?: number; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of activity relating to the specified pull request.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/approve`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/approve": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        approved?: boolean;
                        lastReviewedCommit?: string;
                        role?: "PARTICIPANT"
                        | "REVIEWER"
                        | "AUTHOR";
                        status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                        user?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        approved?: boolean;
                        lastReviewedCommit?: string;
                        role?: "PARTICIPANT"
                        | "REVIEWER"
                        | "AUTHOR";
                        status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                        user?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Unapprove pull request
Deprecated
Description
Remove approval from a pull request as the current user. This does not remove the user as a participant.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource. Deprecated since 4.2. Use /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug} instead
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Details of the updated participant.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist or the current user is not a participant on the pull request.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request is not open.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Approve pull request
Deprecated
Description
Approve a pull request as the current user. Implicitly adds the user as a participant if they are not already.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource. Deprecated since 4.2. Use /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug} instead
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Details of the new participant.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request is not open.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/auto-merge`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/auto-merge": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        autoSubject?: boolean;
                        createdDate?: number;
                        fromHash?: string;
                        message?: string;
                        strategyId?: string;
                        toRefId?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        autoMergeProcessingStatus?: | "MERGED"
                        | "UNKNOWN"
                        | "CANCELLED"
                        | "LOCK_FAILURE"
                        | "STALE"
                        | "VETOED";
                        pullRequest?: {
                            closed?: boolean;
                            closedDate?: number;
                            createdDate?: number;
                            description?: string;
                            descriptionAsHtml?: string;
                            draft?: boolean;
                            fromRef?: {
                                displayId?: (...)
                                | (...);
                                id?: (...) | (...);
                                latestCommit?: (...) | (...);
                                repository?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            htmlDescription?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            locked?: boolean;
                            open?: boolean;
                            participants?: readonly {
                                approved?: ...;
                                lastReviewedCommit?: ...;
                                role?: ...;
                                status?: ...;
                                user?: ...;
                            }[];
                            reviewers?: readonly {
                                approved?: ...;
                                lastReviewedCommit?: ...;
                                role?: ...;
                                status?: ...;
                                user?: ...;
                            }[];
                            state?: "DECLINED"
                            | "MERGED"
                            | "OPEN";
                            title?: string;
                            toRef?: {
                                displayId?: (...) | (...);
                                id?: (...) | (...);
                                latestCommit?: (...) | (...);
                                repository?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Cancel auto-merge for pull request
Description
Cancels a request to auto-merge the pull request, if the pull request was not merged yet.
The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The auto-merge request was cancelled.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to modify the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified pull request is not open.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { autoSubject?: boolean; createdDate?: number; fromHash?: string; message?: string; strategyId?: string; toRefId?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get auto-merge request for pull request
Description
Returns an auto-merge request for the pull request, if requested.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { autoSubject?: boolean; createdDate?: number; fromHash?: string; message?: string; strategyId?: string; toRefId?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { autoSubject?: boolean; createdDate?: number; fromHash?: string; message?: string; strategyId?: string; toRefId?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The auto-merge request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { autoMergeProcessingStatus?: | "MERGED" | "UNKNOWN" | "CANCELLED" | "LOCK_FAILURE" | "STALE" | "VETOED"; pullRequest?: { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: (...) | (...); id?: (...) | (...); latestCommit?: (...) | (...); repository?: (...) | (...); type?: (...) | (...) | (...); }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: ...; lastReviewedCommit?: ...; role?: ...; status?: ...; user?: ...; }[]; reviewers?: readonly { approved?: ...; lastReviewedCommit?: ...; role?: ...; status?: ...; user?: ...; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: (...) | (...); id?: (...) | (...); latestCommit?: (...) | (...); repository?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Auto-merge pull request
Description
Requests the system to try merging the pull request if auto-merge was requested on it.
The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { autoMergeProcessingStatus?: | "MERGED" | "UNKNOWN" | "CANCELLED" | "LOCK_FAILURE" | "STALE" | "VETOED"; pullRequest?: { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: (...) | (...); id?: (...) | (...); latestCommit?: (...) | (...); repository?: (...) | (...); type?: (...) | (...) | (...); }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: ...; lastReviewedCommit?: ...; role?: ...; status?: ...; user?: ...; }[]; reviewers?: readonly { approved?: ...; lastReviewedCommit?: ...; role?: ...; status?: ...; user?: ...; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: (...) | (...); id?: (...) | (...); latestCommit?: (...) | (...); repository?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { autoMergeProcessingStatus?: | "MERGED" | "UNKNOWN" | "CANCELLED" | "LOCK_FAILURE" | "STALE" | "VETOED"; pullRequest?: { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: (...) | (...); id?: (...) | (...); latestCommit?: (...) | (...); repository?: (...) | (...); type?: (...) | (...) | (...); }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: ...; lastReviewedCommit?: ...; role?: ...; status?: ...; user?: ...; }[]; reviewers?: readonly { approved?: ...; lastReviewedCommit?: ...; role?: ...; status?: ...; user?: ...; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: (...) | (...); id?: (...) | (...); latestCommit?: (...) | (...); repository?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The result of trying to auto-merge the pull request.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 An auto-merge request was not submitted for this pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to modify the pull request.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The auto-merge setting is not enabled for the repository that this pull request targets.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: {
                count?: string;
                limit?: number;
                start?: number;
                state?: readonly string[];
                states?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            anchor?: {
                                diffType?: ...;
                                fileType?: ...;
                                fromHash?: ...;
                                line?: ...;
                                lineType?: ...;
                                multilineMarker?: ...;
                                path?: ...;
                                pullRequest?: ...;
                                srcPath?: ...;
                                toHash?: ...;
                            };
                            anchored?: boolean;
                            author?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            parent?: {
                                anchor?: ...;
                                anchored?: ...;
                                author?: ...;
                                comments?: ...;
                                createdDate?: ...;
                                html?: ...;
                                id?: ...;
                                pending?: ...;
                                properties?: ...;
                                reply?: ...;
                                resolvedDate?: ...;
                                resolver?: ...;
                                severity?: ...;
                                state?: ...;
                                text?: ...;
                                threadResolved?: ...;
                                threadResolvedDate?: ...;
                                threadResolver?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            };
                            pending?: boolean;
                            properties?: Record<(...), (...)>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    anchor?: {
                        diffType?: "COMMIT"
                        | "EFFECTIVE"
                        | "RANGE";
                        fileType?: "FROM" | "TO";
                        fromHash?: string;
                        line?: number;
                        lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                        multilineMarker?: {
                            startLine?: (...) | (...);
                            startLineType: (...) | (...) | (...);
                        };
                        path?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        pullRequest?: {
                            closed?: (...)
                            | (...)
                            | (...);
                            closedDate?: (...) | (...);
                            createdDate?: (...) | (...);
                            description?: (...) | (...);
                            descriptionAsHtml?: (...) | (...);
                            draft?: (...) | (...) | (...);
                            fromRef?: (...) | (...);
                            htmlDescription?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            locked?: (...) | (...) | (...);
                            open?: (...) | (...) | (...);
                            participants?: (...) | (...);
                            reviewers?: (...) | (...);
                            state?: (...) | (...) | (...) | (...);
                            title?: (...) | (...);
                            toRef?: (...) | (...);
                            updatedDate?: (...) | (...);
                            version?: (...) | (...);
                        };
                        srcPath?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        toHash?: string;
                    };
                    anchored?: boolean;
                    author?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    comments?: readonly (
                        { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                    )[];
                    createdDate?: number;
                    html?: string;
                    id?: number;
                    parent?: {
                        anchor?: {
                            diffType?: (...)
                            | (...)
                            | (...)
                            | (...);
                            fileType?: (...) | (...) | (...);
                            fromHash?: (...) | (...);
                            line?: (...) | (...);
                            lineType?: (...) | (...) | (...) | (...);
                            multilineMarker?: (...) | (...);
                            path?: (...) | (...);
                            pullRequest?: (...) | (...);
                            srcPath?: (...) | (...);
                            toHash?: (...) | (...);
                        };
                        anchored?: boolean;
                        author?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: (...) | (...) | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                    pending?: boolean;
                    properties?: Record<string, unknown>;
                    reply?: boolean;
                    resolvedDate?: number;
                    resolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    severity?: string;
                    state?: string;
                    text?: string;
                    threadResolved?: boolean;
                    threadResolvedDate?: number;
                    threadResolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    updatedDate?: number;
                    version?: number;
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        anchor?: {
                            diffType?: "COMMIT"
                            | "EFFECTIVE"
                            | "RANGE";
                            fileType?: "FROM" | "TO";
                            fromHash?: string;
                            line?: number;
                            lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                            multilineMarker?: {
                                startLine?: (...) | (...);
                                startLineType: (...) | (...) | (...);
                            };
                            path?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            pullRequest?: {
                                closed?: (...)
                                | (...)
                                | (...);
                                closedDate?: (...) | (...);
                                createdDate?: (...) | (...);
                                description?: (...) | (...);
                                descriptionAsHtml?: (...) | (...);
                                draft?: (...) | (...) | (...);
                                fromRef?: (...) | (...);
                                htmlDescription?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                locked?: (...) | (...) | (...);
                                open?: (...) | (...) | (...);
                                participants?: (...) | (...);
                                reviewers?: (...) | (...);
                                state?: (...) | (...) | (...) | (...);
                                title?: (...) | (...);
                                toRef?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            srcPath?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            toHash?: string;
                        };
                        anchored?: boolean;
                        author?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        parent?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly (
                                { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                            )[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { count?: string; limit?: number; start?: number; state?: readonly string[]; states?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Search pull request comments
Description
Gets comments matching the given set of field values for the specified pull request. (Note this does not perform any kind of searching for comments by their text).
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { count?: string; limit?: number; start?: number; state?: readonly string[]; states?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { count?: string; limit?: number; start?: number; state?: readonly string[]; states?: string; }
 - Optional Readonlycount?: string
 Description
 If true only the count of the comments by state will be returned (and not the body of the comments).
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlystate?: readonly string[]
 - Optional Readonlystates?: string
 Description
 (optional). If supplied, only comments with a state in the given list will be returned. The state can be OPEN or RESOLVED.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of Comments from the supplied pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository or pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }; responses: { "201": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add new blocker comment
Description
Add a new blocker comment.
Comments can be added in a few places by setting different attributes: General pull request blocker comment: ``` { "text": "A task on a pull request." } ``` Blocker reply to a comment: ``` { "text": "This reply is a task.", "parent": { "id": 1 } } ``` General blocker file comment: ``` { "text": "A blocker comment on a file.", "anchor": { "diffType": "RANGE", "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd", "path": "path/to/file", "srcPath": "path/to/file", "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b" } } ``` Blocker file line comment: ``` { "text": "A task on a particular line within a file.", "anchor": { "diffType": "COMMIT", "line": 1, "lineType": "CONTEXT", "fileType": "FROM", "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd", "path": "path/to/file", "srcPath": "path/to/file", "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b" } } ``` For file and line comments, 'path' refers to the path of the file to which the comment should be applied and 'srcPath' refers to the path the that file used to have (only required for copies and moves). Also, fromHash and toHash refer to the sinceId / untilId (respectively) used to produce the diff on which the comment was added. Finally diffType refers to the type of diff the comment was added on. For backwards compatibility purposes if no diffType is provided and no fromHash/toHash pair is provided the diffType will be resolved to 'EFFECTIVE'. In any other cases the diffType is REQUIRED. For line comments, 'line' refers to the line in the diff that the comment should apply to. 'lineType' refers to the type of diff hunk, which can be: - 'ADDED' - for an added line; - 'REMOVED' - for a removed line; or - 'CONTEXT' - for a line that was unmodified but is in the vicinity of the diff. 'fileType' refers to the file of the diff to which the anchor should be attached - which is of relevance when displaying the diff in a side-by-side way. Currently the supported values are: - 'FROM' - the source file of the diff - 'TO' - the destination file of the diff If the current user is not a participant the user is added as a watcher of the pull request. The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }
 Description
 The comment to add.
- Readonlyresponses: { "201": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created comment.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment was not created due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request, create a comment or watch the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, pull request or parent comment.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The new created name already exists or adding, deleting, or editing comments isn't supported on archived repositories.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments/{commentId}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments/{commentId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: { version?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        anchor?: {
                            diffType?: "COMMIT"
                            | "EFFECTIVE"
                            | "RANGE";
                            fileType?: "FROM" | "TO";
                            fromHash?: string;
                            line?: number;
                            lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                            multilineMarker?: {
                                startLine?: (...) | (...);
                                startLineType: (...) | (...) | (...);
                            };
                            path?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            pullRequest?: {
                                closed?: (...)
                                | (...)
                                | (...);
                                closedDate?: (...) | (...);
                                createdDate?: (...) | (...);
                                description?: (...) | (...);
                                descriptionAsHtml?: (...) | (...);
                                draft?: (...) | (...) | (...);
                                fromRef?: (...) | (...);
                                htmlDescription?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                locked?: (...) | (...) | (...);
                                open?: (...) | (...) | (...);
                                participants?: (...) | (...);
                                reviewers?: (...) | (...);
                                state?: (...) | (...) | (...) | (...);
                                title?: (...) | (...);
                                toRef?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            srcPath?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            toHash?: string;
                        };
                        anchored?: boolean;
                        author?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        parent?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly (
                                { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                            )[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    anchor?: {
                        diffType?: "COMMIT"
                        | "EFFECTIVE"
                        | "RANGE";
                        fileType?: "FROM" | "TO";
                        fromHash?: string;
                        line?: number;
                        lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                        multilineMarker?: {
                            startLine?: (...) | (...);
                            startLineType: (...) | (...) | (...);
                        };
                        path?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        pullRequest?: {
                            closed?: (...)
                            | (...)
                            | (...);
                            closedDate?: (...) | (...);
                            createdDate?: (...) | (...);
                            description?: (...) | (...);
                            descriptionAsHtml?: (...) | (...);
                            draft?: (...) | (...) | (...);
                            fromRef?: (...) | (...);
                            htmlDescription?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            locked?: (...) | (...) | (...);
                            open?: (...) | (...) | (...);
                            participants?: (...) | (...);
                            reviewers?: (...) | (...);
                            state?: (...) | (...) | (...) | (...);
                            title?: (...) | (...);
                            toRef?: (...) | (...);
                            updatedDate?: (...) | (...);
                            version?: (...) | (...);
                        };
                        srcPath?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        toHash?: string;
                    };
                    anchored?: boolean;
                    author?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    comments?: readonly (
                        { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                    )[];
                    createdDate?: number;
                    html?: string;
                    id?: number;
                    parent?: {
                        anchor?: {
                            diffType?: (...)
                            | (...)
                            | (...)
                            | (...);
                            fileType?: (...) | (...) | (...);
                            fromHash?: (...) | (...);
                            line?: (...) | (...);
                            lineType?: (...) | (...) | (...) | (...);
                            multilineMarker?: (...) | (...);
                            path?: (...) | (...);
                            pullRequest?: (...) | (...);
                            srcPath?: (...) | (...);
                            toHash?: (...) | (...);
                        };
                        anchored?: boolean;
                        author?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: (...) | (...) | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                    pending?: boolean;
                    properties?: Record<string, unknown>;
                    reply?: boolean;
                    resolvedDate?: number;
                    resolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    severity?: string;
                    state?: string;
                    text?: string;
                    threadResolved?: boolean;
                    threadResolvedDate?: number;
                    threadResolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    updatedDate?: number;
                    version?: number;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        anchor?: {
                            diffType?: "COMMIT"
                            | "EFFECTIVE"
                            | "RANGE";
                            fileType?: "FROM" | "TO";
                            fromHash?: string;
                            line?: number;
                            lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                            multilineMarker?: {
                                startLine?: (...) | (...);
                                startLineType: (...) | (...) | (...);
                            };
                            path?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            pullRequest?: {
                                closed?: (...)
                                | (...)
                                | (...);
                                closedDate?: (...) | (...);
                                createdDate?: (...) | (...);
                                description?: (...) | (...);
                                descriptionAsHtml?: (...) | (...);
                                draft?: (...) | (...) | (...);
                                fromRef?: (...) | (...);
                                htmlDescription?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                locked?: (...) | (...) | (...);
                                open?: (...) | (...) | (...);
                                participants?: (...) | (...);
                                reviewers?: (...) | (...);
                                state?: (...) | (...) | (...) | (...);
                                title?: (...) | (...);
                                toRef?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            srcPath?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            toHash?: string;
                        };
                        anchored?: boolean;
                        author?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        parent?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly (
                                { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                            )[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { version?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete pull request comment
Description
Delete a pull request comment. Anyone can delete their own comment. Only users with REPO_ADMIN and above may delete comments created by other users.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { version?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The ID of the comment to retrieve.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { version?: string }
 - Optional Readonlyversion?: string
 Description
 The expected version of the comment. This must match the server's version of the comment or the delete will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the delete. Look for the 'version' attribute in the returned JSON structure.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The operation was successful.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the comment.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository or pull request.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment has replies, the version supplied does not match the current version or the repository is archived.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request comment
Description
Retrieves a pull request comment.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The ID of the comment to retrieve
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested comment.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the comment.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, pull request or comment.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }; responses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update pull request comment
Description
Update a comment, with the following restrictions:
- only the author of the comment may update the text of the comment - only the author of the comment, the author of the pull request or repository admins and above may update the other fields of a comment Convert a comment to a task or vice versa. Comments can be converted to tasks by setting the 'severity' attribute to 'BLOCKER': ``` { "severity": "BLOCKER" } ``` Tasks can be converted to comments by setting the 'severity' attribute to 'NORMAL': ``` { "severity": "NORMAL" } ``` Resolve a blocker comment. Blocker comments can be resolved by setting the 'state' attribute to 'RESOLVED': ``` { "state": "RESOLVED" } ``` Note: the supplied JSON object must contain a <code>version</code> that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure. The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The ID of the comment to retrieve.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }
 Description
 The comment to add.
- Readonlyresponses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly updated comment.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment was not updated due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request, update a comment or watch the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, pull request or comment.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment version supplied does not match the current version or the repository is archived.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/changes`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/changes": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: {
                changeScope?: string;
                limit?: number;
                sinceId?: string;
                start?: number;
                untilId?: string;
                withComments?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        conflict?: {
                            ourChange?: {
                                path?: (...)
                                | (...);
                                srcPath?: (...) | (...);
                                type?: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                            };
                            theirChange?: {
                                path?: (...)
                                | (...);
                                srcPath?: (...) | (...);
                                type?: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                            };
                        };
                        contentId?: string;
                        executable?: boolean;
                        fromContentId?: string;
                        links?: Record<string, unknown>;
                        nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE";
                        path?: {
                            components?: readonly string[];
                            extension?: string;
                            name?: string;
                            parent?: string;
                        };
                        percentUnchanged?: number;
                        srcExecutable?: boolean;
                        srcPath?: {
                            components?: readonly string[];
                            extension?: string;
                            name?: string;
                            parent?: string;
                        };
                        type?: "UNKNOWN"
                        | "DELETE"
                        | "ADD"
                        | "COPY"
                        | "MODIFY"
                        | "MOVE";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { changeScope?: string; limit?: number; sinceId?: string; start?: number; untilId?: string; withComments?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { conflict?: { ourChange?: { path?: (...) | (...); srcPath?: (...) | (...); type?: (...) | (...) | (...) | (...) | (...) | (...) | (...); }; theirChange?: { path?: (...) | (...); srcPath?: (...) | (...); type?: (...) | (...) | (...) | (...) | (...) | (...) | (...); }; }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<string, unknown>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Gets pull request changes
Description
Gets changes for the specified PullRequest.
If the changeScope query parameter is set to 'UNREVIEWED', the application will attempt to stream unreviewed changes based on the lastReviewedCommit of the current user, which are the changes between the lastReviewedCommit and the latest commit of the source branch. The current user is considered to not have any unreviewed changes for the pull request when the lastReviewedCommit is either null (everything is unreviewed, so all changes are streamed), equal to the latest commit of the source branch (everything is reviewed), or no longer on the source branch (the source branch has been rebased). In these cases, the application will fall back to streaming all changes (the default), which is the effective diff for the pull request. The type of changes streamed can be determined by the changeScope parameter included in the properties map of the response. Note: This resource is currently not paged. The server will return at most one page. The server will truncate the number of changes to either the request's page limit or an internal maximum, whichever is smaller. The start parameter of the page request is also ignored. The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { changeScope?: string; limit?: number; sinceId?: string; start?: number; untilId?: string; withComments?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { changeScope?: string; limit?: number; sinceId?: string; start?: number; untilId?: string; withComments?: string; }
 - Optional ReadonlychangeScope?: string
 Description
 UNREVIEWED to stream the unreviewed changes for the current user (if they exist); RANGE to stream changes between two arbitrary commits (requires 'sinceId' and 'untilId'); otherwise ALL to stream all changes (the default)
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional ReadonlysinceId?: string
 Description
 The since commit hash to stream changes for a RANGE arbitrary change scope
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional ReadonlyuntilId?: string
 Description
 The until commit hash to stream changes for a RANGE arbitrary change scope
 - Optional ReadonlywithComments?: string
 Description
 true to apply comment counts in the changes (the default); otherwise, false to stream changes without comment counts
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { conflict?: { ourChange?: { path?: (...) | (...); srcPath?: (...) | (...); type?: (...) | (...) | (...) | (...) | (...) | (...) | (...); }; theirChange?: { path?: (...) | (...); srcPath?: (...) | (...); type?: (...) | (...) | (...) | (...) | (...) | (...) | (...); }; }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<string, unknown>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { conflict?: { ourChange?: { path?: (...) | (...); srcPath?: (...) | (...); type?: (...) | (...) | (...) | (...) | (...) | (...) | (...); }; theirChange?: { path?: (...) | (...); srcPath?: (...) | (...); type?: (...) | (...) | (...) | (...) | (...) | (...) | (...); }; }; contentId?: string; executable?: boolean; fromContentId?: string; links?: Record<string, unknown>; nodeType?: "DIRECTORY" | "FILE" | "SUBMODULE"; path?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; percentUnchanged?: number; srcExecutable?: boolean; srcPath?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; type?: "UNKNOWN" | "DELETE" | "ADD" | "COPY" | "MODIFY" | "MOVE"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of unreviewed Changes for the current user from the supplied pull request, including the unreviewedCommits in the properties map.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository or pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query: {
                anchorState?: string;
                diffType?: readonly string[];
                diffTypes?: string;
                fromHash?: string;
                limit?: number;
                path: string;
                start?: number;
                state?: readonly string[];
                states?: string;
                toHash?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            anchor?: {
                                diffType?: ...;
                                fileType?: ...;
                                fromHash?: ...;
                                line?: ...;
                                lineType?: ...;
                                multilineMarker?: ...;
                                path?: ...;
                                pullRequest?: ...;
                                srcPath?: ...;
                                toHash?: ...;
                            };
                            anchored?: boolean;
                            author?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            parent?: {
                                anchor?: ...;
                                anchored?: ...;
                                author?: ...;
                                comments?: ...;
                                createdDate?: ...;
                                html?: ...;
                                id?: ...;
                                pending?: ...;
                                properties?: ...;
                                reply?: ...;
                                resolvedDate?: ...;
                                resolver?: ...;
                                severity?: ...;
                                state?: ...;
                                text?: ...;
                                threadResolved?: ...;
                                threadResolvedDate?: ...;
                                threadResolver?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            };
                            pending?: boolean;
                            properties?: Record<(...), (...)>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    anchor?: {
                        diffType?: "COMMIT"
                        | "EFFECTIVE"
                        | "RANGE";
                        fileType?: "FROM" | "TO";
                        fromHash?: string;
                        line?: number;
                        lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                        multilineMarker?: {
                            startLine?: (...) | (...);
                            startLineType: (...) | (...) | (...);
                        };
                        path?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        pullRequest?: {
                            closed?: (...)
                            | (...)
                            | (...);
                            closedDate?: (...) | (...);
                            createdDate?: (...) | (...);
                            description?: (...) | (...);
                            descriptionAsHtml?: (...) | (...);
                            draft?: (...) | (...) | (...);
                            fromRef?: (...) | (...);
                            htmlDescription?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            locked?: (...) | (...) | (...);
                            open?: (...) | (...) | (...);
                            participants?: (...) | (...);
                            reviewers?: (...) | (...);
                            state?: (...) | (...) | (...) | (...);
                            title?: (...) | (...);
                            toRef?: (...) | (...);
                            updatedDate?: (...) | (...);
                            version?: (...) | (...);
                        };
                        srcPath?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        toHash?: string;
                    };
                    anchored?: boolean;
                    author?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    comments?: readonly (
                        { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                    )[];
                    createdDate?: number;
                    html?: string;
                    id?: number;
                    parent?: {
                        anchor?: {
                            diffType?: (...)
                            | (...)
                            | (...)
                            | (...);
                            fileType?: (...) | (...) | (...);
                            fromHash?: (...) | (...);
                            line?: (...) | (...);
                            lineType?: (...) | (...) | (...) | (...);
                            multilineMarker?: (...) | (...);
                            path?: (...) | (...);
                            pullRequest?: (...) | (...);
                            srcPath?: (...) | (...);
                            toHash?: (...) | (...);
                        };
                        anchored?: boolean;
                        author?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: (...) | (...) | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                    pending?: boolean;
                    properties?: Record<string, unknown>;
                    reply?: boolean;
                    resolvedDate?: number;
                    resolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    severity?: string;
                    state?: string;
                    text?: string;
                    threadResolved?: boolean;
                    threadResolvedDate?: number;
                    threadResolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    updatedDate?: number;
                    version?: number;
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        anchor?: {
                            diffType?: "COMMIT"
                            | "EFFECTIVE"
                            | "RANGE";
                            fileType?: "FROM" | "TO";
                            fromHash?: string;
                            line?: number;
                            lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                            multilineMarker?: {
                                startLine?: (...) | (...);
                                startLineType: (...) | (...) | (...);
                            };
                            path?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            pullRequest?: {
                                closed?: (...)
                                | (...)
                                | (...);
                                closedDate?: (...) | (...);
                                createdDate?: (...) | (...);
                                description?: (...) | (...);
                                descriptionAsHtml?: (...) | (...);
                                draft?: (...) | (...) | (...);
                                fromRef?: (...) | (...);
                                htmlDescription?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                locked?: (...) | (...) | (...);
                                open?: (...) | (...) | (...);
                                participants?: (...) | (...);
                                reviewers?: (...) | (...);
                                state?: (...) | (...) | (...) | (...);
                                title?: (...) | (...);
                                toRef?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            srcPath?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            toHash?: string;
                        };
                        anchored?: boolean;
                        author?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        parent?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly (
                                { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                            )[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query: { anchorState?: string; diffType?: readonly string[]; diffTypes?: string; fromHash?: string; limit?: number; path: string; start?: number; state?: readonly string[]; states?: string; toHash?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request comments for path
Description
Gets comments for the specified pull request and path.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query: { anchorState?: string; diffType?: readonly string[]; diffTypes?: string; fromHash?: string; limit?: number; path: string; start?: number; state?: readonly string[]; states?: string; toHash?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Readonlyquery: { anchorState?: string; diffType?: readonly string[]; diffTypes?: string; fromHash?: string; limit?: number; path: string; start?: number; state?: readonly string[]; states?: string; toHash?: string; }
 - Optional ReadonlyanchorState?: string
 Description
 ACTIVE to stream the active comments; ORPHANED to stream the orphaned comments; ALL to stream both the active and the orphaned comments;
 - Optional ReadonlydiffType?: readonly string[]
 - Optional ReadonlydiffTypes?: string
 Description
 EFFECTIVE to stream the comments related to the effective diff of the pull request; RANGE to stream comments related to a commit range between two arbitrary commits (requires 'fromHash' and 'toHash'); COMMIT to stream comments related to a commit between two arbitrary commits (requires 'fromHash' and 'toHash')
 - Optional ReadonlyfromHash?: string
 Description
 The from commit hash to stream comments for a RANGE or COMMIT arbitrary change scope
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Readonlypath: string
 Description
 The path to stream comments for a given path
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlystate?: readonly string[]
 - Optional Readonlystates?: string
 Description
 (optional). If supplied, only comments with a state in the given list will be returned. The state can be OPEN or RESOLVED.
 - Optional ReadonlytoHash?: string
 Description
 The to commit hash to stream comments for a RANGE or COMMIT arbitrary change scope
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of Comments from the supplied pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository or pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }; responses: { "201": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add pull request comment
Description
Add a new comment.
Comments can be added in a few places by setting different attributes: General pull request comment: <pre> { "text": "An insightful general comment on a pull request." } </pre> Reply to a comment: <pre> { "text": "A measured reply.", "parent": { "id": 1 } } </pre> General file comment: <pre> { "text": "An insightful general comment on a file.", "anchor": { "diffType": "RANGE", "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd", "path": "path/to/file", "srcPath": "path/to/file", "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b" } } </pre> File line comment: <pre> { "text": "A pithy comment on a particular line within a file.", "anchor": { "diffType": "COMMIT", "line": 1, "lineType": "CONTEXT", "fileType": "FROM", "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd", "path": "path/to/file", "srcPath": "path/to/file", "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b" } } </pre> Add a new task. Tasks are just comments with the attribute 'severity' set to 'BLOCKER': General pull request task: <pre> { "text": "A task on a pull request.", "severity": "BLOCKER" } </pre> Add a pending comment. Pending comments are just comments with the attribute 'state' set to 'PENDING': Pending comment: <pre> { "text": "This is a pending comment", "state": "PENDING" } </pre> For file and line comments, 'path' refers to the path of the file to which the comment should be applied and 'srcPath' refers to the path the that file used to have (only required for copies and moves). Also, fromHash and toHash refer to the sinceId / untilId (respectively) used to produce the diff on which the comment was added. Finally diffType refers to the type of diff the comment was added on. For backwards compatibility purposes if no diffType is provided and no fromHash/toHash pair is provided the diffType will be resolved to 'EFFECTIVE'. In any other cases the diffType is REQUIRED. For line comments, 'line' refers to the line in the diff that the comment should apply to. 'lineType' refers to the type of diff hunk, which can be: - 'ADDED' - for an added line; - 'REMOVED' - for a removed line; or - 'CONTEXT' - for a line that was unmodified but is in the vicinity of the diff. </ul>'fileType' refers to the file of the diff to which the anchor should be attached - which is of relevance when displaying the diff in a side-by-side way. Currently the supported values are: - 'FROM' - the source file of the diff - 'TO' - the destination file of the diff </ul>If the current user is not a participant the user is added as a watcher of the pull request. The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }
 Description
 The comment to add
- Readonlyresponses: { "201": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created comment.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment was not created due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request, create a comment or watch the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, pull request or parent comment.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Adding, deleting, or editing comments isn't supported on archived repositories.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: { version?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        anchor?: {
                            diffType?: "COMMIT"
                            | "EFFECTIVE"
                            | "RANGE";
                            fileType?: "FROM" | "TO";
                            fromHash?: string;
                            line?: number;
                            lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                            multilineMarker?: {
                                startLine?: (...) | (...);
                                startLineType: (...) | (...) | (...);
                            };
                            path?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            pullRequest?: {
                                closed?: (...)
                                | (...)
                                | (...);
                                closedDate?: (...) | (...);
                                createdDate?: (...) | (...);
                                description?: (...) | (...);
                                descriptionAsHtml?: (...) | (...);
                                draft?: (...) | (...) | (...);
                                fromRef?: (...) | (...);
                                htmlDescription?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                locked?: (...) | (...) | (...);
                                open?: (...) | (...) | (...);
                                participants?: (...) | (...);
                                reviewers?: (...) | (...);
                                state?: (...) | (...) | (...) | (...);
                                title?: (...) | (...);
                                toRef?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            srcPath?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            toHash?: string;
                        };
                        anchored?: boolean;
                        author?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        parent?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly (
                                { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                            )[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    anchor?: {
                        diffType?: "COMMIT"
                        | "EFFECTIVE"
                        | "RANGE";
                        fileType?: "FROM" | "TO";
                        fromHash?: string;
                        line?: number;
                        lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                        multilineMarker?: {
                            startLine?: (...) | (...);
                            startLineType: (...) | (...) | (...);
                        };
                        path?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        pullRequest?: {
                            closed?: (...)
                            | (...)
                            | (...);
                            closedDate?: (...) | (...);
                            createdDate?: (...) | (...);
                            description?: (...) | (...);
                            descriptionAsHtml?: (...) | (...);
                            draft?: (...) | (...) | (...);
                            fromRef?: (...) | (...);
                            htmlDescription?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            locked?: (...) | (...) | (...);
                            open?: (...) | (...) | (...);
                            participants?: (...) | (...);
                            reviewers?: (...) | (...);
                            state?: (...) | (...) | (...) | (...);
                            title?: (...) | (...);
                            toRef?: (...) | (...);
                            updatedDate?: (...) | (...);
                            version?: (...) | (...);
                        };
                        srcPath?: {
                            components?: (...)
                            | (...);
                            extension?: (...) | (...);
                            name?: (...) | (...);
                            parent?: (...) | (...);
                        };
                        toHash?: string;
                    };
                    anchored?: boolean;
                    author?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    comments?: readonly (
                        { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                    )[];
                    createdDate?: number;
                    html?: string;
                    id?: number;
                    parent?: {
                        anchor?: {
                            diffType?: (...)
                            | (...)
                            | (...)
                            | (...);
                            fileType?: (...) | (...) | (...);
                            fromHash?: (...) | (...);
                            line?: (...) | (...);
                            lineType?: (...) | (...) | (...) | (...);
                            multilineMarker?: (...) | (...);
                            path?: (...) | (...);
                            pullRequest?: (...) | (...);
                            srcPath?: (...) | (...);
                            toHash?: (...) | (...);
                        };
                        anchored?: boolean;
                        author?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: (...) | (...) | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                    pending?: boolean;
                    properties?: Record<string, unknown>;
                    reply?: boolean;
                    resolvedDate?: number;
                    resolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    severity?: string;
                    state?: string;
                    text?: string;
                    threadResolved?: boolean;
                    threadResolvedDate?: number;
                    threadResolver?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                    updatedDate?: number;
                    version?: number;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        anchor?: {
                            diffType?: "COMMIT"
                            | "EFFECTIVE"
                            | "RANGE";
                            fileType?: "FROM" | "TO";
                            fromHash?: string;
                            line?: number;
                            lineType?: "ADDED" | "CONTEXT" | "REMOVED";
                            multilineMarker?: {
                                startLine?: (...) | (...);
                                startLineType: (...) | (...) | (...);
                            };
                            path?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            pullRequest?: {
                                closed?: (...)
                                | (...)
                                | (...);
                                closedDate?: (...) | (...);
                                createdDate?: (...) | (...);
                                description?: (...) | (...);
                                descriptionAsHtml?: (...) | (...);
                                draft?: (...) | (...) | (...);
                                fromRef?: (...) | (...);
                                htmlDescription?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                locked?: (...) | (...) | (...);
                                open?: (...) | (...) | (...);
                                participants?: (...) | (...);
                                reviewers?: (...) | (...);
                                state?: (...) | (...) | (...) | (...);
                                title?: (...) | (...);
                                toRef?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            srcPath?: {
                                components?: (...)
                                | (...);
                                extension?: (...) | (...);
                                name?: (...) | (...);
                                parent?: (...) | (...);
                            };
                            toHash?: string;
                        };
                        anchored?: boolean;
                        author?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        comments?: readonly (
                            { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                        )[];
                        createdDate?: number;
                        html?: string;
                        id?: number;
                        parent?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly (
                                { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }
                            )[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        pending?: boolean;
                        properties?: Record<string, unknown>;
                        reply?: boolean;
                        resolvedDate?: number;
                        resolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        severity?: string;
                        state?: string;
                        text?: string;
                        threadResolved?: boolean;
                        threadResolvedDate?: number;
                        threadResolver?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { version?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a pull request comment
Description
Delete a pull request comment. Anyone can delete their own comment. Only users with REPO_ADMIN and above may delete comments created by other users.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { version?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The ID of the comment to retrieve.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { version?: string }
 - Optional Readonlyversion?: string
 Description
 The expected version of the comment. This must match the server's version of the comment or the delete will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the delete. Look for the 'version' attribute in the returned JSON structure.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The operation was successful.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the comment.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository or pull request.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment has replies, the version supplied does not match the current version or the repository is archived.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a pull request comment
Description
Retrieves a pull request comment.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The ID of the comment to retrieve.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested comment.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the comment.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, pull request or comment.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }; responses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update pull request comment
Description
Update a comment, with the following restrictions:
- only the author of the comment may update the text of the comment - only the author of the comment, the author of the pull request or repository admins and above may update the other fields of a comment </ul> Convert a comment to a task or vice versa. Comments can be converted to tasks by setting the 'severity' attribute to 'BLOCKER': <pre> { "severity": "BLOCKER" } </pre> Tasks can be converted to comments by setting the 'severity' attribute to 'NORMAL': <pre> { "severity": "NORMAL" } </pre> Resolve a task. Tasks can be resolved by setting the 'state' attribute to 'RESOLVED': <pre> { "state": "RESOLVED" } </pre> Note: the supplied JSON object must contain a <code>version</code> that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure. The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The ID of the comment to retrieve.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; }
 Description
 The updated comment
- Readonlyresponses: { "200": { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { anchor?: { diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; fileType?: "FROM" | "TO"; fromHash?: string; line?: number; lineType?: "ADDED" | "CONTEXT" | "REMOVED"; multilineMarker?: { startLine?: (...) | (...); startLineType: (...) | (...) | (...); }; path?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; pullRequest?: { closed?: (...) | (...) | (...); closedDate?: (...) | (...); createdDate?: (...) | (...); description?: (...) | (...); descriptionAsHtml?: (...) | (...); draft?: (...) | (...) | (...); fromRef?: (...) | (...); htmlDescription?: (...) | (...); id?: (...) | (...); links?: (...) | (...); locked?: (...) | (...) | (...); open?: (...) | (...) | (...); participants?: (...) | (...); reviewers?: (...) | (...); state?: (...) | (...) | (...) | (...); title?: (...) | (...); toRef?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; srcPath?: { components?: (...) | (...); extension?: (...) | (...); name?: (...) | (...); parent?: (...) | (...); }; toHash?: string; }; anchored?: boolean; author?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly ( { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; } )[]; createdDate?: number; html?: string; id?: number; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly updated comment.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment was not updated due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request, update a comment or watch the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, pull request or comment.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The comment version supplied does not match the current version or the repository is archived.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/apply-suggestion`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/apply-suggestion": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    commentVersion?: { asInt?: number; present?: boolean };
                    commitMessage?: string;
                    pullRequestVersion?: { asInt?: number; present?: boolean };
                    suggestionIndex?: { asInt?: number; present?: boolean };
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { commentVersion?: { asInt?: number; present?: boolean }; commitMessage?: string; pullRequestVersion?: { asInt?: number; present?: boolean }; suggestionIndex?: { asInt?: number; present?: boolean }; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Apply pull request suggestion
Description
Apply a suggestion contained within a comment.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The ID of the comment to retrieve.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { commentVersion?: { asInt?: number; present?: boolean }; commitMessage?: string; pullRequestVersion?: { asInt?: number; present?: boolean }; suggestionIndex?: { asInt?: number; present?: boolean }; }; }; }
 Description
 A request containing other parameters required to apply a suggestion - The given versions/hashes must match the server's version/hashes or the suggestion application will fail (in order to avoid applying the suggestion to the wrong place
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating the suggestion has been applied.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The suggestion was not applied due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to apply the suggestion.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied project, repository, pull request or parent comment.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 There was an error applying the suggestion to the source branch. It must be applied manually.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commit-message-suggestion`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commit-message-suggestion": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { body?: string; title?: string } };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { body?: string; title?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get commit message suggestion
Description
Retrieve a suggested commit message for the given Pull Request.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request to generate the suggestion for
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { body?: string; title?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { body?: string; title?: string } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The suggested commit message
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commits`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commits": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: {
                avatarScheme?: string;
                avatarSize?: string;
                limit?: number;
                start?: number;
                withCounts?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
                            authorTimestamp?: number;
                            committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... };
                            committerTimestamp?: number;
                            displayId?: string;
                            id?: string;
                            message?: string;
                            parents?: readonly (...)[];
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { avatarScheme?: string; avatarSize?: string; limit?: number; start?: number; withCounts?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; authorTimestamp?: number; committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request commits
Description
Retrieve commits for the specified pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { avatarScheme?: string; avatarSize?: string; limit?: number; start?: number; withCounts?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 ID of the pullrequest, part of the path
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { avatarScheme?: string; avatarSize?: string; limit?: number; start?: number; withCounts?: string; }
 - Optional ReadonlyavatarScheme?: string
 Description
 The desired scheme for the avatar URL. If the parameter is not present URLs will use the same scheme as this request
 - Optional ReadonlyavatarSize?: string
 Description
 If present the service adds avatar URLs for commit authors. Should be an integer specifying the desired size in pixels. If the parameter is not present, avatar URLs will not be setCOMMIT to stream comments related to a commit between two arbitrary commits (requires 'fromHash' and 'toHash')
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional ReadonlywithCounts?: string
 Description
 If set to true, the service will add "authorCount" and "totalCount" at the end of the page. "authorCount" is the number of different authors and "totalCount" is the total number of commits.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; authorTimestamp?: number; committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { author?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; authorTimestamp?: number; committer?: { avatarUrl?: ...; emailAddress?: ...; name?: ... }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of commits from the supplied pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository or pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/decline`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/decline": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: { version?: string };
        };
        requestBody?: {
            content: {
                "application/json": { comment?: string; version?: number };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        closed?: boolean;
                        closedDate?: number;
                        createdDate?: number;
                        description?: string;
                        descriptionAsHtml?: string;
                        draft?: boolean;
                        fromRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...)
                                | (...)
                                | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        htmlDescription?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        locked?: boolean;
                        open?: boolean;
                        participants?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        reviewers?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT"
                            | "REVIEWER"
                            | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        state?: "DECLINED"
                        | "MERGED"
                        | "OPEN";
                        title?: string;
                        toRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { version?: string }; }; requestBody?: { content: { "application/json": { comment?: string; version?: number } }; }; responses: { "200": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Decline pull request
Description
Decline a pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { version?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pullrequest ID provided by the path
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { version?: string }
 - Optional Readonlyversion?: string
 Description
 The current version of the pull request. If the server's version isn't the same as the specified version the operation will fail. To determine the current version of the pull request it should be fetched from the server prior to this operation. Look for the 'version' attribute in the returned JSON structure.
- Optional ReadonlyrequestBody?: { content: { "application/json": { comment?: string; version?: number } } }
 Description
 Optional body
- Readonlyresponses: { "200": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request was declined.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request is not OPEN or has been updated since the version specified by the request.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff-stats-summary/{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff-stats-summary/{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                path: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: {
                sinceId?: string;
                srcPath?: string;
                untilId?: string;
                whitespace?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { sinceId?: string; srcPath?: string; untilId?: string; whitespace?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get diff stats summary for pull request
Description
Retrieve the diff stats summary for the given Pull Request.
The stats summary include the total number of modified files, added lines, and deleted lines. Note: The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { sinceId?: string; srcPath?: string; untilId?: string; whitespace?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { path: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - Readonlypath: string
 Description
 Optional path to the file which should be diffed
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { sinceId?: string; srcPath?: string; untilId?: string; whitespace?: string }
 - Optional ReadonlysinceId?: string
 Description
 The since commit hash to stream a diff between two arbitrary hashes
 - Optional ReadonlysrcPath?: string
 Description
 The previous path to the file, if the file has been copied, moved or renamed
 - Optional ReadonlyuntilId?: string
 Description
 The until commit hash to stream a diff between two arbitrary hashes
 - Optional Readonlywhitespace?: string
 Description
 Optional whitespace flag which can be set to ignore-all
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The diff stats summary
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff/{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff/{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                path: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: {
                avatarScheme?: string;
                avatarSize?: string;
                contextLines?: string;
                diffType?: string;
                sinceId?: string;
                srcPath?: string;
                untilId?: string;
                whitespace?: string;
                withComments?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        binary?: boolean;
                        destination?: {
                            components?: readonly string[];
                            extension?: string;
                            name?: string;
                            parent?: string;
                        };
                        hunks?: readonly {
                            context?: string;
                            destinationLine?: number;
                            destinationSpan?: number;
                            segments?: readonly (...)[];
                            sourceLine?: number;
                            sourceSpan?: number;
                            truncated?: boolean;
                        }[];
                        lineComments?: readonly {
                            anchor?: {
                                diffType?: ...;
                                fileType?: ...;
                                fromHash?: ...;
                                line?: ...;
                                lineType?: ...;
                                multilineMarker?: ...;
                                path?: ...;
                                pullRequest?: ...;
                                srcPath?: ...;
                                toHash?: ...;
                            };
                            anchored?: boolean;
                            author?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            parent?: {
                                anchor?: ...;
                                anchored?: ...;
                                author?: ...;
                                comments?: ...;
                                createdDate?: ...;
                                html?: ...;
                                id?: ...;
                                pending?: ...;
                                properties?: ...;
                                reply?: ...;
                                resolvedDate?: ...;
                                resolver?: ...;
                                severity?: ...;
                                state?: ...;
                                text?: ...;
                                threadResolved?: ...;
                                threadResolvedDate?: ...;
                                threadResolver?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            };
                            pending?: boolean;
                            properties?: Record<(...), (...)>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                        properties?: Record<string, unknown>;
                        source?: {
                            components?: readonly string[];
                            extension?: string;
                            name?: string;
                            parent?: string;
                        };
                        truncated?: boolean;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { avatarScheme?: string; avatarSize?: string; contextLines?: string; diffType?: string; sinceId?: string; srcPath?: string; untilId?: string; whitespace?: string; withComments?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Stream a diff within a pull request
Description
Streams a diff within a pull request.
If the specified file has been copied, moved or renamed, the <code>srcPath</code> must also be specified to produce the correct diff. To stream a raw text representation of the diff, this endpoint can be called with the request header 'Accept: text/plain'. Note: This RESTful endpoint is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded. The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { avatarScheme?: string; avatarSize?: string; contextLines?: string; diffType?: string; sinceId?: string; srcPath?: string; untilId?: string; whitespace?: string; withComments?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { path: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - Readonlypath: string
 Description
 The path to the file which should be diffed (optional)
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { avatarScheme?: string; avatarSize?: string; contextLines?: string; diffType?: string; sinceId?: string; srcPath?: string; untilId?: string; whitespace?: string; withComments?: string; }
 - Optional ReadonlyavatarScheme?: string
 Description
 The security scheme for avatar URLs. If the scheme is not present then it is inherited from the request. It can be set to "https" to force the use of secure URLs. Not applicable if streaming raw diff
 - Optional ReadonlyavatarSize?: string
 Description
 If present the service adds avatar URLs for comment authors where the provided value specifies the desired avatar size in pixels. Not applicable if streaming raw diff
 - Optional ReadonlycontextLines?: string
 Description
 The number of context lines to include around added/removed lines in the diff
 - Optional ReadonlydiffType?: string
 Description
 The type of diff being requested. When withComments is true this works as a hint to the system to attach the correct set of comments to the diff. Not applicable if streaming raw diff
 - Optional ReadonlysinceId?: string
 Description
 The since commit hash to stream a diff between two arbitrary hashes
 - Optional ReadonlysrcPath?: string
 Description
 The previous path to the file, if the file has been copied, moved or renamed
 - Optional ReadonlyuntilId?: string
 Description
 The until commit hash to stream a diff between two arbitrary hashes
 - Optional Readonlywhitespace?: string
 Description
 Optional whitespace flag which can be set to ignore-all
 - Optional ReadonlywithComments?: string
 Description
 true to embed comments in the diff (the default); otherwise, false to stream the diff without comments. Not applicable if streaming raw diff
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { binary?: boolean; destination?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; hunks?: readonly { context?: string; destinationLine?: number; destinationSpan?: number; segments?: readonly (...)[]; sourceLine?: number; sourceSpan?: number; truncated?: boolean; }[]; lineComments?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; properties?: Record<string, unknown>; source?: { components?: readonly string[]; extension?: string; name?: string; parent?: string; }; truncated?: boolean; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of differences from a pull request.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 If the request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository or pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        conflicted?: boolean;
                        outcome?: "UNKNOWN"
                        | "CLEAN"
                        | "CONFLICTED";
                        vetoes?: readonly {
                            detailedMessage?: string;
                            summaryMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: { version?: string };
        };
        requestBody?: {
            content: {
                "application/json": {
                    autoMerge?: boolean;
                    autoSubject?: string;
                    message?: string;
                    strategyId?: string;
                    version?: number;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        closed?: boolean;
                        closedDate?: number;
                        createdDate?: number;
                        description?: string;
                        descriptionAsHtml?: string;
                        draft?: boolean;
                        fromRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...)
                                | (...)
                                | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        htmlDescription?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        locked?: boolean;
                        open?: boolean;
                        participants?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        reviewers?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT"
                            | "REVIEWER"
                            | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        state?: "DECLINED"
                        | "MERGED"
                        | "OPEN";
                        title?: string;
                        toRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { conflicted?: boolean; outcome?: "UNKNOWN" | "CLEAN" | "CONFLICTED"; vetoes?: readonly { detailedMessage?: string; summaryMessage?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Test if pull request can be merged
Description
Test whether a pull request can be merged.
A pull request may not be merged if: - there are conflicts that need to be manually resolved before merging; and/or - one or more merge checks have vetoed the merge. The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { conflicted?: boolean; outcome?: "UNKNOWN" | "CLEAN" | "CONFLICTED"; vetoes?: readonly { detailedMessage?: string; summaryMessage?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { conflicted?: boolean; outcome?: "UNKNOWN" | "CLEAN" | "CONFLICTED"; vetoes?: readonly { detailedMessage?: string; summaryMessage?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The mergeability status of the pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified pull request is not open.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { version?: string }; }; requestBody?: { content: { "application/json": { autoMerge?: boolean; autoSubject?: string; message?: string; strategyId?: string; version?: number; }; }; }; responses: { "200": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Merge pull request
Description
Merge the specified pull request immediately or set the pull request to auto-merge when all the merge checks pass by setting autoMerge field in the request body.
The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { version?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { version?: string }
 - Optional Readonlyversion?: string
 Description
 The current version of the pull request. If the server's version isn't the same as the specified version the operation will fail. To determine the current version of the pull request it should be fetched from the server prior to this operation. Look for the 'version' attribute in the returned JSON structure.
- Optional ReadonlyrequestBody?: { content: { "application/json": { autoMerge?: boolean; autoSubject?: string; message?: string; strategyId?: string; version?: number; }; }; }
 Description
 The body holder
- Readonlyresponses: { "200": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The merged pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to merge the specified pull request
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The auto-merge setting is not enabled for the repository that this pull request targets.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One of the following error cases occurred (check the error message for more details):
 - The pull request has conflicts. - A merge check vetoed the merge. - The specified version is out of date. - The specified pull request is not open. - The to repository is archived.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge-base`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge-base": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        author?: {
                            avatarUrl?: string;
                            emailAddress?: string;
                            name?: string;
                        };
                        authorTimestamp?: number;
                        committer?: {
                            avatarUrl?: string;
                            emailAddress?: string;
                            name?: string;
                        };
                        committerTimestamp?: number;
                        displayId?: string;
                        id?: string;
                        message?: string;
                        parents?: readonly { displayId?: string; id?: string }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string; }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string; }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get the common ancestor between the latest commits of the source and target branches of the pull request
Description
Returns the best common ancestor between the latest commits of the source and target branches of the pull request.
If more than one best common ancestor exists, only one will be returned. It is unspecified which will be returned.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { author?: { avatarUrl?: string; emailAddress?: string; name?: string }; authorTimestamp?: number; committer?: { avatarUrl?: string; emailAddress?: string; name?: string }; committerTimestamp?: number; displayId?: string; id?: string; message?: string; parents?: readonly { displayId?: string; id?: string }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The common ancestor of the latest commits in the source and target branches of this pull request
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 No common parent between exist
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project, repository, or pull request does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: { username?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT"
                            | "REVIEWER"
                            | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    role?: "PARTICIPANT"
                    | "REVIEWER"
                    | "AUTHOR";
                    user?: {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        approved?: boolean;
                        lastReviewedCommit?: string;
                        role?: "PARTICIPANT"
                        | "REVIEWER"
                        | "AUTHOR";
                        status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                        user?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { username?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Unassign pull request participant
Deprecated
Description
Unassigns a participant from the REVIEWER role they may have been given in a pull request.
If the participant has no explicit role this method has no effect. Afterwards, the user will still remain a participant in the pull request but their role will be reduced to PARTICIPANT. This is because once made a participant of a pull request, a user will forever remain a participant. Only their role may be altered. The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource. Deprecated since 4.2. Use /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug} instead.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { username?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { username?: string }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The update completed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Removing reviewers isn't supported on archived repositories.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request participants
Description
Retrieves a page of the participants for a given pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Details of the participants in this pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody: { content: { "application/json": { role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; }; responses: { "200": { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Assign pull request participant role
Description
Assigns a participant to an explicit role in pull request. Currently only the REVIEWER role may be assigned.
If the user is not yet a participant in the pull request, they are made one and assigned the supplied role. If the user is already a participant in the pull request, their previous role is replaced with the supplied role unless they are already assigned the AUTHOR role which cannot be changed and will result in a Bad Request (400) response code. The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "application/json": { role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; }
 Description
 The participant to be added to the pull request, includes the user and their role
- Readonlyresponses: { "200": { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Details of the participants in this pull request.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request does not have the username and role, or is attempting an invalid assignment.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Adding reviewers isn't supported on archived repositories
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
                userSlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
                userSlug: string;
            };
            query?: { version?: string };
        };
        requestBody: {
            content: {
                "application/json": {
                    lastReviewedCommit?: string;
                    status?: "APPROVED"
                    | "NEEDS_WORK"
                    | "UNAPPROVED";
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        approved?: boolean;
                        lastReviewedCommit?: string;
                        role?: "PARTICIPANT"
                        | "REVIEWER"
                        | "AUTHOR";
                        status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                        user?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; userSlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Unassign pull request participant
Description
Unassigns a participant from the REVIEWER role they may have been given in a pull request.
If the participant has no explicit role this method has no effect. Afterwards, the user will still remain a participant in the pull request but their role will be reduced to PARTICIPANT. This is because once made a participant of a pull request, a user will forever remain a participant. Only their role may be altered. The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; userSlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string; userSlug: string; }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlyuserSlug: string
 Description
 The slug for the user being unassigned
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The update completed.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request does not have the username.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Removing reviewers isn't supported on archived repositories.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; userSlug: string; }; query?: { version?: string }; }; requestBody: { content: { "application/json": { lastReviewedCommit?: string; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; }; }; }; responses: { "200": { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Change pull request status
Description
Change the current user's status for a pull request. Implicitly adds the user as a participant if they are not already. If the current user is the author, this method will fail.
The possible values for {@code status} are UNAPPROVED, NEEDS_WORK (which is referred to as "Requested changes" in the frontend from 8.10 onward), or APPROVED. If the new {@code status} is NEEDS_WORK or APPROVED then the {@code lastReviewedCommit} for the participant will be updated to the latest commit of the source branch of the pull request. The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; userSlug: string; }; query?: { version?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string; userSlug: string; }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlyuserSlug: string
 Description
 The slug for the user changing their status
 - Optional Readonlyquery?: { version?: string }
 - Optional Readonlyversion?: string
 Deprecated
 Description
 The current version of the pull request. If the server's version isn't the same as the specified version the operation will fail. To determine the current version of the pull request it should be fetched from the server prior to this operation. Look for the 'version' attribute in the returned JSON structure. Note: This parameter is deprecated. Use last reviewed commit in request body instead
- ReadonlyrequestBody: { content: { "application/json": { lastReviewedCommit?: string; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; }; }; }
 Description
 The participant representing the status to set, includes the status of the participant and last reviewed commit. If last reviewed commit is provided, it will be used to update the participant status. The operation will fail if the latest commit of the pull request does not match the provided last reviewed commit. If last reviewed commit is not provided, the latest commit of the pull request will be used for the update by default.
- Readonlyresponses: { "200": { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Details of the new participant.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified status was invalid or the currently authenticated user is the author of the PR and cannot have its status updated.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request is not open, or has been updated since the last reviewed commit specified by the request.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/reopen`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/reopen": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: { version?: string };
        };
        requestBody?: { content: { "application/json": { version?: number } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        closed?: boolean;
                        closedDate?: number;
                        createdDate?: number;
                        description?: string;
                        descriptionAsHtml?: string;
                        draft?: boolean;
                        fromRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        htmlDescription?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        locked?: boolean;
                        open?: boolean;
                        participants?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        reviewers?: readonly {
                            approved?: boolean;
                            lastReviewedCommit?: string;
                            role?: "PARTICIPANT"
                            | "REVIEWER"
                            | "AUTHOR";
                            status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED";
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                        state?: "DECLINED"
                        | "MERGED"
                        | "OPEN";
                        title?: string;
                        toRef?: {
                            displayId?: string;
                            id?: string;
                            latestCommit?: string;
                            repository?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                origin?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            type?: "BRANCH"
                            | "TAG";
                        };
                        updatedDate?: number;
                        version?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { version?: string }; }; requestBody?: { content: { "application/json": { version?: number } } }; responses: { "200": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Re-open pull request
Description
Re-open a declined pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { version?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { version?: string }
 - Optional Readonlyversion?: string
 Description
 The current version of the pull request. If the server's version isn't the same as the specified version the operation will fail. To determine the current version of the pull request it should be fetched from the server prior to this operation. Look for the 'version' attribute in the returned JSON structure.
- Optional ReadonlyrequestBody?: { content: { "application/json": { version?: number } } }
 Description
 The body holder
- Readonlyresponses: { "200": { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { closed?: boolean; closedDate?: number; createdDate?: number; description?: string; descriptionAsHtml?: string; draft?: boolean; fromRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; htmlDescription?: string; id?: number; links?: Record<string, unknown>; locked?: boolean; open?: boolean; participants?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; reviewers?: readonly { approved?: boolean; lastReviewedCommit?: string; role?: "PARTICIPANT" | "REVIEWER" | "AUTHOR"; status?: "APPROVED" | "NEEDS_WORK" | "UNAPPROVED"; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; state?: "DECLINED" | "MERGED" | "OPEN"; title?: string; toRef?: { displayId?: string; id?: string; latestCommit?: string; repository?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); origin?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; type?: "BRANCH" | "TAG"; }; updatedDate?: number; version?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The merged pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to reopen the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One of the following error cases occurred (check the error message for more details):
 - The pull request is not in a declined state. - The specified version is out of date. - The to repository is archived.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/review`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/review": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            anchor?: {
                                diffType?: ...;
                                fileType?: ...;
                                fromHash?: ...;
                                line?: ...;
                                lineType?: ...;
                                multilineMarker?: ...;
                                path?: ...;
                                pullRequest?: ...;
                                srcPath?: ...;
                                toHash?: ...;
                            };
                            anchored?: boolean;
                            author?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...;
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            parent?: {
                                anchor?: ...;
                                anchored?: ...;
                                author?: ...;
                                comments?: ...;
                                createdDate?: ...;
                                html?: ...;
                                id?: ...;
                                pending?: ...;
                                properties?: ...;
                                reply?: ...;
                                resolvedDate?: ...;
                                resolver?: ...;
                                severity?: ...;
                                state?: ...;
                                text?: ...;
                                threadResolved?: ...;
                                threadResolvedDate?: ...;
                                threadResolver?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            };
                            pending?: boolean;
                            properties?: Record<(...), (...)>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                            updatedDate?: number;
                            version?: number;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: { version?: string };
        };
        requestBody?: {
            content: {
                "application/json": {
                    commentText?: string;
                    lastReviewedCommit?: string;
                    participantStatus?: string;
                };
            };
        };
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Discard pull request review
Description
Discard a pull request review for the authenticated user.
The authenticated user must have REPO_READ permission for the repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The pull request review has been discarded.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to discard the the pull request review
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified pull request or repository does not exist.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request comment thread
Description
Get the CommentThread threads which have Comment comments that have a CommentState#PENDING pending state and are part of the pull request review for the authenticated user.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { anchor?: { diffType?: ...; fileType?: ...; fromHash?: ...; line?: ...; lineType?: ...; multilineMarker?: ...; path?: ...; pullRequest?: ...; srcPath?: ...; toHash?: ...; }; anchored?: boolean; author?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; comments?: readonly { readonly anchor?: { readonly diffType?: "COMMIT" | "EFFECTIVE" | "RANGE"; readonly fileType?: "FROM" | "TO"; readonly fromHash?: string; readonly line?: number; readonly lineType?: "ADDED" | "CONTEXT" | "REMOVED"; ... 4 more ...; readonly toHash?: string; }; ... 19 more ...; readonly version?: number; }[]...; createdDate?: number; html?: string; id?: number; parent?: { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }; pending?: boolean; properties?: Record<(...), (...)>; reply?: boolean; resolvedDate?: number; resolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; updatedDate?: number; version?: number; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of Comments from the supplied pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository or pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: { version?: string }; }; requestBody?: { content: { "application/json": { commentText?: string; lastReviewedCommit?: string; participantStatus?: string; }; }; }; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Complete pull request review
Description
Complete a review on a pull request.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: { version?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { version?: string }
 - Optional Readonlyversion?: string
 Deprecated
 Description
 The current version of the pull request. If the server's version isn't the same as the specified version the operation will fail. To determine the current version of the pull request it should be fetched from the server prior to this operation. Look for the 'version' attribute in the returned JSON structure. Note: This parameter is deprecated. Use last reviewed commit in request body instead
- Optional ReadonlyrequestBody?: { content: { "application/json": { commentText?: string; lastReviewedCommit?: string; participantStatus?: string; }; }; }
 Description
 The REST request which contains comment text, last reviewed commit and participant status. If last reviewed commit is provided, it will be used to update the participant status. The operation will fail if the latest commit of the pull request does not match the provided last reviewed commit. If last reviewed commit is not provided, the latest commit of the pull request will be used for the update by default.
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 Getting back the number of published comments and completing the review on a pull request.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request is invalid when there is no request body provided, or the participant status in the request is invalid.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request, update a comment or watch the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 There is no pull request review for the user to finish.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request has been updated since the last reviewed commit specified by the request, or reviews cannot be made on pull requests in archived repositories.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Stop watching pull request
Description
Remove the authenticated user as a watcher for the specified pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The user is no longer watching the pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Watch pull request
Description
Add the authenticated user as a watcher for the specified pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request ID.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The user is now watching the pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/raw/{path}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/raw/{path}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { path: string; projectKey: string; repositorySlug: string };
            query?: {
                at?: string;
                hardwrap?: string;
                htmlEscape?: string;
                includeHeadingId?: string;
                markup?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get raw content of a file at revision
Description
Retrieve the raw content for a file path at a specified revision.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { path: string; projectKey: string; repositorySlug: string }; query?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { path: string; projectKey: string; repositorySlug: string }
 - Readonlypath: string
 Description
 The file path to retrieve content from
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }
 - Optional Readonlyat?: string
 Description
 A specific commit or ref to retrieve the raw content at, or the default branch if not specified
 - Optional Readonlyhardwrap?: string
 Description
 (Optional) Whether the markup implementation should convert newlines to breaks. If not specified, the value of the markup.render.hardwrap property, which is true by default, will be used
 - Optional ReadonlyhtmlEscape?: string
 Description
 (Optional) true if HTML should be escaped in the input markup, false otherwise. If not specified, the value of the markup.render.html.escape property, which is true by default, will be used
 - Optional ReadonlyincludeHeadingId?: string
 Description
 (Optional) true if headings should contain an ID based on the heading content. If not specified, the value of the markup.render.headerids property, which is false by default, will be used
 - Optional Readonlymarkup?: string
 Description
 If present or "true", triggers the raw content to be markup-rendered and returned as HTML; otherwise, if not specified, or any value other than "true", the content is streamed without markup
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The raw contents from a file.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The path parameter was not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/readme`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/readme": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                at?: string;
                hardwrap?: string;
                htmlEscape?: string;
                includeHeadingId?: string;
                markup?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository readme
Description
Retrieves the README for the repository, if it's been defined.
This checks the repository for a <pre>README</pre> file, optionally with an <pre>md</pre> or <pre>txt</pre>extension, and, if found, streams it. By default, the raw content of the file is streamed. Appending <pre>?markup</pre> to the URL will stream an HTML-rendered version instead. Note that, when streaming HTML, relative URLs in the README will not work if applied relative to this URL. The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string; hardwrap?: string; htmlEscape?: string; includeHeadingId?: string; markup?: string; }
 - Optional Readonlyat?: string
 Description
 A specific commit or ref to retrieve the guidelines at, or the default branch if not specified
 - Optional Readonlyhardwrap?: string
 Description
 (Optional) Whether the markup implementation should convert newlines to breaks. If not specified, the value of the markup.render.hardwrap property, which is true by default, will be used
 - Optional ReadonlyhtmlEscape?: string
 Description
 (Optional) true if HTML should be escaped in the input markup, false otherwise. If not specified, the value of the markup.render.html.escape property, which is true by default, will be used
 - Optional ReadonlyincludeHeadingId?: string
 Description
 (Optional) true if headings should contain an ID based on the heading content. If not specified, the value of the markup.render.headerids property, which is false by default, will be used
 - Optional Readonlymarkup?: string
 Description
 If present or "true", triggers the raw content to be markup-rendered and returned as HTML; otherwise, if not specified, or any value other than "true", the content is streamed without markup
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The README for the repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to read the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/recreate`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/recreate": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        origin?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            partition?: number;
                            project?: {
                                avatar?: (...) | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                        partition?: number;
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Retry repository creation
Description
If a create or fork operation fails, calling this method will clean up the broken repository and try again. The repository must be in an INITIALISATION_FAILED state.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created repository.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository was not created due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create a repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/ref-change-activities`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/ref-change-activities": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { limit?: number; ref?: string; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            createdDate?: number;
                            id?: number;
                            refChange?: {
                                fromHash?: ...;
                                ref?: ...;
                                refId?: ...;
                                toHash?: ...;
                                type?: ...;
                                updatedType?: ...;
                            };
                            repository?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                origin?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            trigger?: string;
                            user?: {
                                active?: ...;
                                avatarUrl?: ...;
                                displayName?: ...;
                                emailAddress?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                slug?: ...;
                                type?: ...;
                            };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; ref?: string; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: number; id?: number; refChange?: { fromHash?: ...; ref?: ...; refId?: ...; toHash?: ...; type?: ...; updatedType?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; trigger?: string; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get ref change activity
Description
Retrieve a page of repository ref change activity.
The authenticated user must have REPO_ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; ref?: string; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; ref?: string; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyref?: string
 Description
 (optional) exact match for a ref ID to filter ref change activity for
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: number; id?: number; refChange?: { fromHash?: ...; ref?: ...; refId?: ...; toHash?: ...; type?: ...; updatedType?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; trigger?: string; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: number; id?: number; refChange?: { fromHash?: ...; ref?: ...; refId?: ...; toHash?: ...; type?: ...; updatedType?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; trigger?: string; user?: { active?: ...; avatarUrl?: ...; displayName?: ...; emailAddress?: ...; id?: ...; links?: ...; name?: ...; slug?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of ref change activity.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user is currently not authenticated or the user does not have REPO_ADMIN permission.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/ref-change-activities/branches`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/ref-change-activities/branches": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { filterText?: string; limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            displayId?: string;
                            id?: string;
                            type?: "BRANCH"
                            | "TAG";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filterText?: string; limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { displayId?: string; id?: string; type?: "BRANCH" | "TAG"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get branches with ref change activities for repository
Description
Retrieve a page of branches with ref change activities for a specific repository.
The authenticated user must have REPO_ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filterText?: string; limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { filterText?: string; limit?: number; start?: number }
 - Optional ReadonlyfilterText?: string
 Description
 (optional) Partial match for a ref ID to filter minimal refs for
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { displayId?: string; id?: string; type?: "BRANCH" | "TAG"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { displayId?: string; id?: string; type?: "BRANCH" | "TAG"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of branches with ref change activities.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user is currently not authenticated or the user does not have REPO_ADMIN permission.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/related`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/related": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            origin?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            partition?: number;
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            public?: boolean;
                            relatedLinks?: Record<(...), (...)>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get related repository
Description
Retrieve repositories which are related to this one. Related repositories are from the same Repository#getHierarchyId() hierarchy as this repository.
Only repositories to which the authenticated user has REPO_READ permission will be included, even if more repositories are part of this repository's hierarchy.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of repositories related to the request repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to see the request repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                filter?: string;
                limit?: number;
                order?: "NAME_ASC" | "NAME_DESC";
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            id?: number;
                            lineRegex?: string;
                            name?: string;
                            pathRegex?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find repository secret scanning allowlist rules
Description
Find repository secret scanning allowlist rules by filtering.
Repository **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }
 - Optional Readonlyfilter?: string
 Description
 Filter names by the provided text
 Example
 Access
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyorder?: "NAME_ASC" | "NAME_DESC"
 Description
 Order by
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Page of allowlist rules
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was not a correctly formed allowlist rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to view repository rules
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create repository secret scanning allowlist rule
Description
Create a new repository secret scanning allowlist rule. Repository allowlist rules are used when scanning the given repository.
Repository **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }
 Description
 Allowlist rule to create, either the line regular expression or the path regular expression must be present
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The created rule
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed allowlist rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to create repository rules
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist/{id}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a repository secret scanning allowlist rule
Description
Delete a repository secret scanning allowlist rule with the provided ID.
Repository **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The allowlist rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 Empty response indicating that the allowlist rule was deleted
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to delete repository allowlist rules
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a repository secret scanning allowlist rule
Description
Get a repository secret scanning allowlist rule by ID.
Repository **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The allowlist rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested allowlist rule
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to view repository allowlist rules
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested allowlist rule was not found
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Edit an existing repository secret scanning allowlist rule
Description
Edit a repository secret scanning allowlist rule.
Repository **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The allowlist rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated allowlist rule
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed allowlist rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to edit repository allowlist rules
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/exempt`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/exempt": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete an exempt repository
Description
Remove a repository from being exempt from secret scanning
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 Empty response indicating that the exempt repository was deleted
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to delete an exempt repository
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get whether a repository is exempt
Description
Check whether a repository is exempt from secret scanning
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 True if the repository is exempt from secret scanning, false otherwise
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to check whether a repository is exempt from secret scanning
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Exempt a repo from secret scanning
Deprecated
Description
Exempt a repository from being scanned for secrets
Deprecated since 8.6. Exemptions are now managed by scope. Use POST /rest/api/1.0/secret-scanning/exempt for global scope Use POST /rest/api/1.0/projects/{projectKey}/secret-scanning/exempt for the project scope
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An exempt repo was added
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to exempt a repository from secret scanning
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 At least one of specified repositories have already been previously made exempt.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                filter?: string;
                limit?: number;
                order?: "NAME_ASC" | "NAME_DESC";
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            id?: number;
                            lineRegex?: string;
                            name?: string;
                            pathRegex?: string;
                            scope?: { resourceId?: ...; type?: ... };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find repository secret scanning rules
Description
Find repository secret scanning rules by filtering.
Repository **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }
 - Optional Readonlyfilter?: string
 Description
 Filter names by the provided text
 Example
 Access
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyorder?: "NAME_ASC" | "NAME_DESC"
 Description
 Order by
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Page of rules
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was not correctly formed rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to view repository rules
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create repository secret scanning rule
Description
Create a new repository secret scanning rule. Repository rules are used when scanning the given repository.
Repository **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }
 Description
 Rule to create, either the line regular expression or the path regular expression must be present
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The created rule
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to create repository rules
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules/{id}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a repository secret scanning rule
Description
Delete a repository secret scanning rule with the provided ID.
Repository **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 Empty response indicating that the rule was deleted
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to delete repository rules
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a repository secret scanning rule
Description
Get a repository secret scanning rule by ID.
Repository **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested rule
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to view repository rules
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested rule was not found
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Edit an existing repository secret scanning rule
Description
Edit a repository secret scanning rule.
Repository **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated rule
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to edit repository rules
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/auto-decline`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/auto-decline": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        enabled?: boolean;
                        inactivityWeeks?: number;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": { enabled?: boolean; inactivityWeeks?: number };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        enabled?: boolean;
                        inactivityWeeks?: number;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete auto decline settings
Description
Delete auto decline settings for the supplied repository.
The authenticated user must have REPO_ADMIN permission for this repository to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The auto decline settings have been deleted successfully.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the auto decline settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get auto decline settings
Description
Retrieves the auto decline settings for the supplied repository. Project settings will be returned if no explicit settings have been set for the repository. In the case that there are no project settings, the default settings will be returned.
The authenticated user must have REPO_READ permission for this repository to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The auto decline settings
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the auto decline settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number }; }; }; responses: { "200": { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create auto decline settings
Description
Creates or updates the auto decline settings for the supplied repository.
The authenticated user must have REPO_ADMIN permission for this repository to call the resource
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number }; }; }
 Description
 The settings to create or update
- Readonlyresponses: { "200": { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The auto decline settings
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 inactivityWeeks was not one of 1, 2, 4, 8, or, 12, or the enabled parameter was not included in the request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create or update the auto decline settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/auto-merge`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/auto-merge": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        enabled?: boolean;
                        restrictionState?: | "NONE"
                        | "RESTRICTED_MODIFIABLE"
                        | "RESTRICTED_UNMODIFIABLE";
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: { content: { "application/json": { enabled?: boolean } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        enabled?: boolean;
                        restrictionState?:
                            | "NONE"
                            | "RESTRICTED_MODIFIABLE"
                            | "RESTRICTED_UNMODIFIABLE";
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete pull request auto-merge settings
Description
Deletes pull request auto-merge settings for the supplied repository.
The authenticated user must have REPO_ADMIN permission for this repository to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The pull request auto-merge settings
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the pull request auto-merge settings.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request auto-merge settings cannot be modified due to a restriction enforced by the supplied repository's project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request auto-merge settings
Description
Retrieves the pull request auto-merge settings for the supplied repository. Project settings will be returned if no explicit settings have been set for the repository. In the case that there are no project settings, the default settings will be returned. If the repository's project has restricted its auto-merge settings, then the settings of the project will be returned.
The authenticated user must have REPO_READ permission for this repository to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request auto-merge settings
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the pull request auto-merge settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { enabled?: boolean } } }; responses: { "200": { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create or update the pull request auto-merge settings
Description
Creates or updates the pull request auto-merge settings for the supplied repository.
The authenticated user must have REPO_ADMIN permission for this repository to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { enabled?: boolean } } }
 Description
 The settings to create or update
- Readonlyresponses: { "200": { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "403": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request auto-merge settings
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The 'enabled' field was not provided correctly.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create or update the pull request auto-merge settings.
 - Readonly403: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request auto-merge settings cannot be modified due to a restriction enforced by the supplied repository's project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                limit?: number;
                start?: number;
                type?: "POST_RECEIVE" | "PRE_RECEIVE";
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            configured?: boolean;
                            details?: {
                                configFormKey?: ...;
                                description?: ...;
                                key?: ...;
                                name?: ...;
                                supportedScopes?: ...;
                                type?: ...;
                                version?: ...;
                            };
                            enabled?: boolean;
                            scope?: { resourceId?: ...; type?: ... };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number; type?: "POST_RECEIVE" | "PRE_RECEIVE"; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { configured?: boolean; details?: { configFormKey?: ...; description?: ...; key?: ...; name?: ...; supportedScopes?: ...; type?: ...; version?: ...; }; enabled?: boolean; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository hooks
Description
Retrieve a page of repository hooks for this repository.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number; type?: "POST_RECEIVE" | "PRE_RECEIVE"; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; start?: number; type?: "POST_RECEIVE" | "PRE_RECEIVE" }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlytype?: "POST_RECEIVE" | "PRE_RECEIVE"
 Description
 The optional type to filter by.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { configured?: boolean; details?: { configFormKey?: ...; description?: ...; key?: ...; name?: ...; supportedScopes?: ...; type?: ...; version?: ...; }; enabled?: boolean; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { configured?: boolean; details?: { configFormKey?: ...; description?: ...; key?: ...; name?: ...; supportedScopes?: ...; type?: ...; version?: ...; }; enabled?: boolean; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of repository hooks with their associated enabled state.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the hooks.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { hookKey: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { hookKey: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        configured?: boolean;
                        details?: {
                            configFormKey?: string;
                            description?: string;
                            key?: string;
                            name?: string;
                            supportedScopes?: readonly ((...) | (...) | (...))[];
                            type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
                            version?: string;
                        };
                        enabled?: boolean;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete repository hook
Description
Delete repository hook configuration for the supplied hookKey and repositorySlug
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { hookKey: string; projectKey: string; repositorySlug: string }
 - ReadonlyhookKey: string
 Description
 The hook key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The hook configuration matching the supplied hookKey and repositorySlug was deleted
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings specified are invalid.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the hook.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or hook does not exist.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository hook
Description
Retrieve a repository hook for this repository.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { hookKey: string; projectKey: string; repositorySlug: string }
 - ReadonlyhookKey: string
 Description
 The hook key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository hooks with their associated enabled state for the supplied hookKey.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the hook.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository hook does not exist for the given repository, or the repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { hookKey: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        configured?: boolean;
                        details?: {
                            configFormKey?: string;
                            description?: string;
                            key?: string;
                            name?: string;
                            supportedScopes?: readonly ((...) | (...) | (...))[];
                            type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
                            version?: string;
                        };
                        enabled?: boolean;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: { "Content-Length"?: string };
            path: { hookKey: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        configured?: boolean;
                        details?: {
                            configFormKey?: string;
                            description?: string;
                            key?: string;
                            name?: string;
                            supportedScopes?: readonly ((...) | (...) | (...))[];
                            type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
                            version?: string;
                        };
                        enabled?: boolean;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Disable repository hook
Description
Disable a repository hook for this repository.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { hookKey: string; projectKey: string; repositorySlug: string }
 - ReadonlyhookKey: string
 Description
 The hook key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository hooks with their associated enabled state for the supplied hookKey.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to disable the hook.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or hook does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: { "Content-Length"?: string }; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Enable repository hook
Description
Enable a repository hook for this repository and optionally apply new configuration.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource. A JSON document may be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.
- Readonlyparameters: { cookie?: undefined; header?: { "Content-Length"?: string }; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: { "Content-Length"?: string }
 - Optional ReadonlyContent-Length?: string
 Description
 The content length.
 - Readonlypath: { hookKey: string; projectKey: string; repositorySlug: string }
 - ReadonlyhookKey: string
 Description
 The hook key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository hooks with their associated enabled state for the supplied hookKey.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to enable the hook.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or hook does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { hookKey: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        booleanValue?: boolean;
                        doubleValue?: number;
                        integerValue?: number;
                        longValue?: number;
                        stringValue?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { hookKey: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    booleanValue?: boolean;
                    doubleValue?: number;
                    integerValue?: number;
                    longValue?: number;
                    stringValue?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        booleanValue?: boolean;
                        doubleValue?: number;
                        integerValue?: number;
                        longValue?: number;
                        stringValue?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository hook settings
Description
Retrieve the settings for a repository hook for this repository.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { hookKey: string; projectKey: string; repositorySlug: string }
 - ReadonlyhookKey: string
 Description
 The hook key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings for the hook.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the hook settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or hook does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; }; responses: { "200": { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update repository hook settings
Description
Modify the settings for a repository hook for this repository.
The service will reject any settings which are too large, the current limit is 32KB once serialized. The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource. A JSON document can be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { hookKey: string; projectKey: string; repositorySlug: string }
 - ReadonlyhookKey: string
 Description
 The hook key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; }
 Description
 The raw settings.
- Readonlyresponses: { "200": { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings for the hook.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings specified are invalid.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to modify the hook settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or hook does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        mergeConfig?: {
                            commitMessageTemplate?: {
                                body?: (...)
                                | (...);
                                title?: (...) | (...);
                            };
                            commitSummaries?: number;
                            defaultStrategy?: {
                                description?: (...)
                                | (...);
                                enabled?: (...) | (...) | (...);
                                flag?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            strategies?: readonly {
                                description?: ...;
                                enabled?: ...;
                                flag?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                            }[];
                            type?: string;
                        };
                        requiredAllApprovers?: boolean;
                        requiredAllTasksComplete?: boolean;
                        requiredApprovers?: { count?: string; enabled?: boolean };
                        requiredApproversDeprecated?: number;
                        requiredSuccessfulBuilds?: { count?: string; enabled?: boolean };
                        requiredSuccessfulBuildsDeprecated?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    mergeConfig?: {
                        commitMessageTemplate?: {
                            body?: (...)
                            | (...);
                            title?: (...) | (...);
                        };
                        commitSummaries?: number;
                        defaultStrategy?: {
                            description?: (...)
                            | (...);
                            enabled?: (...) | (...) | (...);
                            flag?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        strategies?: readonly {
                            description?: ...;
                            enabled?: ...;
                            flag?: ...;
                            id?: ...;
                            links?: ...;
                            name?: ...;
                        }[];
                        type?: string;
                    };
                    requiredAllApprovers?: boolean;
                    requiredAllTasksComplete?: boolean;
                    requiredApprovers?: { count?: string; enabled?: boolean };
                    requiredApproversDeprecated?: number;
                    requiredSuccessfulBuilds?: { count?: string; enabled?: boolean };
                    requiredSuccessfulBuildsDeprecated?: number;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        mergeConfig?: {
                            commitMessageTemplate?: {
                                body?: (...)
                                | (...);
                                title?: (...) | (...);
                            };
                            commitSummaries?: number;
                            defaultStrategy?: {
                                description?: (...)
                                | (...);
                                enabled?: (...) | (...) | (...);
                                flag?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            strategies?: readonly {
                                description?: ...;
                                enabled?: ...;
                                flag?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                            }[];
                            type?: string;
                        };
                        requiredAllApprovers?: boolean;
                        requiredAllTasksComplete?: boolean;
                        requiredApprovers?: { count?: string; enabled?: boolean };
                        requiredApproversDeprecated?: number;
                        requiredSuccessfulBuilds?: { count?: string; enabled?: boolean };
                        requiredSuccessfulBuildsDeprecated?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; requiredAllApprovers?: boolean; requiredAllTasksComplete?: boolean; requiredApprovers?: { count?: string; enabled?: boolean }; requiredApproversDeprecated?: number; requiredSuccessfulBuilds?: { count?: string; enabled?: boolean }; requiredSuccessfulBuildsDeprecated?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request settings
Description
Retrieve the pull request settings for the context repository.
The authenticated user must have REPO_READ permission for the context repository to call this resource. This resource will call all RestFragments that are registered with the key bitbucket.repository.settings.pullRequests. If any fragment fails validations by returning a non-empty Map of errors, then no fragments will execute. The property keys for the settings that are bundled with the application are - mergeConfig - the merge strategy configuration for pull requests - requiredApprovers - (Deprecated, please use com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook instead) the number of approvals required on a pull request for it to be mergeable, or 0 if the merge check is disabled - com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook - the merge check configuration for required approvers - requiredAllApprovers - whether or not all approvers must approve a pull request for it to be mergeable - requiredAllTasksComplete - whether or not all tasks on a pull request need to be completed for it to be mergeable - requiredSuccessfulBuilds - (Deprecated, please use com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck instead) the number of successful builds on a pull request for it to be mergeable, or 0 if the merge check is disabled - com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck - the merge check configuration for required builds
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; requiredAllApprovers?: boolean; requiredAllTasksComplete?: boolean; requiredApprovers?: { count?: string; enabled?: boolean }; requiredApproversDeprecated?: number; requiredSuccessfulBuilds?: { count?: string; enabled?: boolean }; requiredSuccessfulBuildsDeprecated?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; requiredAllApprovers?: boolean; requiredAllTasksComplete?: boolean; requiredApprovers?: { count?: string; enabled?: boolean }; requiredApproversDeprecated?: number; requiredSuccessfulBuilds?: { count?: string; enabled?: boolean }; requiredSuccessfulBuildsDeprecated?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository pull request settings for the context repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to see the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; requiredAllApprovers?: boolean; requiredAllTasksComplete?: boolean; requiredApprovers?: { count?: string; enabled?: boolean }; requiredApproversDeprecated?: number; requiredSuccessfulBuilds?: { count?: string; enabled?: boolean }; requiredSuccessfulBuildsDeprecated?: number; }; }; }; responses: { "200": { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; requiredAllApprovers?: boolean; requiredAllTasksComplete?: boolean; requiredApprovers?: { count?: string; enabled?: boolean }; requiredApproversDeprecated?: number; requiredSuccessfulBuilds?: { count?: string; enabled?: boolean }; requiredSuccessfulBuildsDeprecated?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update pull request settings
Description
Update the pull request settings for the context repository.
The authenticated user must have REPO_ADMIN permission for the context repository to call this resource. This resource will call all RestFragments that are registered with the key bitbucket.repository.settings.pullRequests. If any fragment fails validations by returning a non-empty Map of errors, then no fragments will execute. Only the settings that should be updated need to be included in the request. The property keys for the settings that are bundled with the application are - mergeConfig - the merge strategy configuration for pull requests - requiredApprovers - (Deprecated, please use com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook instead) the number of approvals required on a pull request for it to be mergeable, or 0 to disable the merge check - com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook - a json map containing the keys 'enabled' (a boolean to enable or disable this merge check) and 'count' (an integer to set the number of required approvals) - requiredAllApprovers - whether or not all approvers must approve a pull request for it to be mergeable - requiredAllTasksComplete - whether or not all tasks on a pull request need to be completed for it to be mergeable - requiredSuccessfulBuilds - (Deprecated, please use com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck instead) the number of successful builds on a pull request for it to be mergeable, or 0 to disable the merge check - com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck - a json map containing the keys 'enabled' (a boolean to enable or disable this merge check) and 'count' (an integer to set the number of required builds) Merge strategy configuration deletion: An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty "mergeConfig" attribute. i.e: ```{ "mergeConfig": { } } ``` Upon completion of this request, the effective configuration will be: - The configuration set for this repository's SCM type as set at the project level, if present, otherwise - the configuration set for this repository's SCM type as set at the instance level, if present, otherwise - the default configuration for this repository's SCM type
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; requiredAllApprovers?: boolean; requiredAllTasksComplete?: boolean; requiredApprovers?: { count?: string; enabled?: boolean }; requiredApproversDeprecated?: number; requiredSuccessfulBuilds?: { count?: string; enabled?: boolean }; requiredSuccessfulBuildsDeprecated?: number; }; }; }
 Description
 The updated settings.
- Readonlyresponses: { "200": { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; requiredAllApprovers?: boolean; requiredAllTasksComplete?: boolean; requiredApprovers?: { count?: string; enabled?: boolean }; requiredApproversDeprecated?: number; requiredSuccessfulBuilds?: { count?: string; enabled?: boolean }; requiredSuccessfulBuildsDeprecated?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; requiredAllApprovers?: boolean; requiredAllTasksComplete?: boolean; requiredApprovers?: { count?: string; enabled?: boolean }; requiredApproversDeprecated?: number; requiredSuccessfulBuilds?: { count?: string; enabled?: boolean }; requiredSuccessfulBuildsDeprecated?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository pull request settings for the context repository.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository pull request settings were not updated due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to see the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            name?: string;
                            scope?: { resourceId?: ...; type?: ... };
                            users?: readonly (...)[];
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    avatarUrl?: string;
                    description?: string;
                    id?: number;
                    name?: string;
                    scope?: {
                        resourceId?: number;
                        type?: "GLOBAL"
                        | "PROJECT"
                        | "REPOSITORY";
                    };
                    users?: readonly {
                        active?: boolean;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL"
                        | "SERVICE";
                    }[];
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        name?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        users?: readonly {
                            active?: boolean;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL"
                            | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: ...; type?: ... }; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all reviewer groups
Description
Retrieve a page of reviewer groups of a given scope.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: ...; type?: ... }; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: ...; type?: ... }; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of reviewer group(s) of the provided scope and its inherited scope.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository scope supplied does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; }; responses: { "201": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create reviewer group
Description
Create a reviewer group.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; }
 Description
 The request containing the details of the reviewer group.
- Readonlyresponses: { "201": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created reviewer group.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request is missing a reviewer group name.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository scope supplied does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The new created name already exists.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        name?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        users?: readonly {
                            active?: boolean;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL"
                            | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    avatarUrl?: string;
                    description?: string;
                    id?: number;
                    name?: string;
                    scope?: {
                        resourceId?: number;
                        type?: "GLOBAL"
                        | "PROJECT"
                        | "REPOSITORY";
                    };
                    users?: readonly {
                        active?: boolean;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL"
                        | "SERVICE";
                    }[];
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        name?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        users?: readonly {
                            active?: boolean;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL"
                            | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete reviewer group
Description
Deletes a reviewer group.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The ID of the reviewer group to be deleted
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The operation was successful
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the reviewer group in this repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied reviewer group ID.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get reviewer group
Description
Retrieve a reviewer group.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The ID of the reviewer group to be retrieved
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The reviewer group.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The ID supplied does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; }; responses: { "200": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update reviewer group attributes
Description
Update the attributes of a reviewer group.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The ID of the reviewer group to be updated
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; }
 Description
 The request containing the attributes of the reviewer group to be updated. Only the attributes to be updated need to be present in this object.
- Readonlyresponses: { "200": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated reviewer group.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated attribute does not meet the requirements. E.g. the name exceeds 50 characters, setting name to blank.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository scope supplied does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The new updated name already exists.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}/users`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}/users": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json;charset=UTF-8": readonly {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    }[];
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json;charset=UTF-8": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json;charset=UTF-8": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json;charset=UTF-8": readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get reviewer group users
Description
Retrieve a list of the users of a reviewer group.
This does not return all the users of the group, only the users who are licensed and have REPO_READ permission for the specified repository. The authenticated user must have REPO_READ permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The ID of the reviewer group to be retrieved
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json;charset=UTF-8": readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json;charset=UTF-8": readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The list of users of a reviewer group.
 - Readonly401: { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The ID supplied does not exist.d
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/tags`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/tags": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                filterText?: string;
                limit?: number;
                orderBy?: string;
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            displayId?: string;
                            hash?: string;
                            id?: string;
                            latestChangeset?: string;
                            latestCommit?: string;
                            type?: "BRANCH"
                            | "TAG";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    message?: string;
                    name?: string;
                    startPoint?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        displayId?: string;
                        hash?: string;
                        id?: string;
                        latestChangeset?: string;
                        latestCommit?: string;
                        type?: "BRANCH"
                        | "TAG";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filterText?: string; limit?: number; orderBy?: string; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find tag
Description
Retrieve the tags matching the supplied filterText param.
The authenticated user must have REPO_READ permission for the context repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { filterText?: string; limit?: number; orderBy?: string; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { filterText?: string; limit?: number; orderBy?: string; start?: number }
 - Optional ReadonlyfilterText?: string
 Description
 The text to match on.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional ReadonlyorderBy?: string
 Description
 Ordering of refs either ALPHABETICAL (by name) or MODIFICATION (last updated)
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The tags matching the supplied filterText.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to read the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { message?: string; name?: string; startPoint?: string; }; }; }; responses: { "200": { content: { "application/json": { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create tag
Description
Creates a tag using the information provided in the RestCreateTagRequest request
The authenticated user must have REPO_WRITE permission for the context repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { message?: string; name?: string; startPoint?: string; }; }; }
 Description
 The request to create a tag containing a name, startPoint, and optionally a message
- Readonlyresponses: { "200": { content: { "application/json": { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The created tag.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to write to the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/tags/{name}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/tags/{name}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { name: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        displayId?: string;
                        hash?: string;
                        id?: string;
                        latestChangeset?: string;
                        latestCommit?: string;
                        type?: "BRANCH"
                        | "TAG";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { name: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get tag
Description
Retrieve a tag in the specified repository.
The authenticated user must have REPO_READ permission for the context repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { name: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { name: string; projectKey: string; repositorySlug: string }
 - Readonlyname: string
 Description
 The name of the tag to be retrieved.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The tag which matches the supplied name.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to read the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified tag does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/watch`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/watch": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    archived?: boolean;
                    defaultBranch?: string;
                    description?: string;
                    forkable?: boolean;
                    hierarchyId?: string;
                    id?: number;
                    links?: Record<string, unknown>;
                    name?: string;
                    origin?: {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        partition?: number;
                        project?: {
                            avatar?: (...) | (...);
                            avatarUrl?: (...) | (...);
                            description?: (...) | (...);
                            id?: (...) | (...);
                            key: string;
                            links?: (...) | (...);
                            name?: (...) | (...);
                            public?: (...) | (...) | (...);
                            scope?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                    partition?: number;
                    project?: {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                    public?: boolean;
                    relatedLinks?: Record<string, unknown>;
                    scmId?: string;
                    scope?: string;
                    slug?: string;
                    state?:
                        | "AVAILABLE"
                        | "INITIALISATION_FAILED"
                        | "INITIALISING"
                        | "OFFLINE";
                    statusMessage?: string;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Stop watching repository
Description
Remove the authenticated user as a watcher for the specified repository.
The authenticated user must have REPO_READ permission for the repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The user is no longer watching the repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Watch repository
Description
Add the authenticated user as a watcher for the specified repository.
The authenticated user must have REPO_READ permission for the repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }
 Description
 The repository to watch.
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The user is now watching the repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { event?: string; statistics?: boolean };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    active?: boolean;
                    configuration?: Record<string, unknown>;
                    credentials?: { password?: string; username?: string };
                    events?: readonly string[];
                    name?: string;
                    scopeType?: string;
                    sslVerificationRequired?: boolean;
                    statistics?: Record<string, unknown>;
                    url?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        configuration?: Record<string, unknown>;
                        credentials?: { password?: string; username?: string };
                        events?: readonly string[];
                        name?: string;
                        scopeType?: string;
                        sslVerificationRequired?: boolean;
                        statistics?: Record<string, unknown>;
                        url?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { event?: string; statistics?: boolean }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find webhooks
Description
Find webhooks in this repository.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { event?: string; statistics?: boolean }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { event?: string; statistics?: boolean }
 - Optional Readonlyevent?: string
 Description
 List of com.atlassian.webhooks.WebhookEvent IDs to filter for
 - Optional Readonlystatistics?: boolean
 Description
 true if statistics should be provided for all found webhooks
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of webhooks.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to find webhooks in the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; }; responses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create webhook
Description
Create a webhook for the repository specified via the URL.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; }
 Description
 The webhook to be created for this repository.
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A created webhook.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The webhook parameters were invalid or not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create webhooks in the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string; webhookId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string; webhookId: string };
            query?: { statistics?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        configuration?: Record<string, unknown>;
                        credentials?: { password?: string; username?: string };
                        events?: readonly string[];
                        name?: string;
                        scopeType?: string;
                        sslVerificationRequired?: boolean;
                        statistics?: Record<string, unknown>;
                        url?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string; webhookId: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    active?: boolean;
                    configuration?: Record<string, unknown>;
                    credentials?: { password?: string; username?: string };
                    events?: readonly string[];
                    name?: string;
                    scopeType?: string;
                    sslVerificationRequired?: boolean;
                    statistics?: Record<string, unknown>;
                    url?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        configuration?: Record<string, unknown>;
                        credentials?: { password?: string; username?: string };
                        events?: readonly string[];
                        name?: string;
                        scopeType?: string;
                        sslVerificationRequired?: boolean;
                        statistics?: Record<string, unknown>;
                        url?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete webhook
Description
Delete a webhook for the repository specified via the URL.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlywebhookId: string
 Description
 The ID of the webhook to be deleted.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The webhook for the repository has been deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete webhooks in the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist, or webhook does not exist in this repository.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: { statistics?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get webhook
Description
Get a webhook by ID.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: { statistics?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlywebhookId: string
 Description
 ID of the webhook
 - Optional Readonlyquery?: { statistics?: string }
 - Optional Readonlystatistics?: string
 Description
 true if statistics should be provided for the webhook
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to get a webhook in the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist, or the webhook does not exist in the repository.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: undefined; }; requestBody?: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; }; responses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update webhook
Description
Update an existing webhook.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlywebhookId: string
 Description
 Id of the existing webhook
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; }
 Description
 The representation of the updated values for the webhook
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update a webhook in this repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist, or the webhook does not exist in the repository.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/latest`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/latest": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string; webhookId: string };
            query?: { event?: string; outcome?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        duration?: number;
                        event?: string;
                        eventScope?: { id?: string; type?: string };
                        finish?: number;
                        id?: number;
                        request?: Record<string, unknown>;
                        result?: Record<string, unknown>;
                        start?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: { event?: string; outcome?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { duration?: number; event?: string; eventScope?: { id?: string; type?: string }; finish?: number; id?: number; request?: Record<string, unknown>; result?: Record<string, unknown>; start?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get last webhook invocation details
Description
Get the latest invocations for a specific webhook.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: { event?: string; outcome?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlywebhookId: string
 Description
 ID of the webhook
 - Optional Readonlyquery?: { event?: string; outcome?: string }
 - Optional Readonlyevent?: string
 Description
 The string ID of a specific event to retrieve the last invocation for.
 - Optional Readonlyoutcome?: string
 Description
 The outcome to filter for. Can be SUCCESS, FAILURE, ERROR. None specified means that the all will be considered
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { duration?: number; event?: string; eventScope?: { id?: string; type?: string }; finish?: number; id?: number; request?: Record<string, unknown>; result?: Record<string, unknown>; start?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { duration?: number; event?: string; eventScope?: { id?: string; type?: string }; finish?: number; id?: number; request?: Record<string, unknown>; result?: Record<string, unknown>; start?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook invocation dataset.
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 No webhook invocations exist.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to get webhook invocations in the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist, or the webhook does not exist in the repository.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string; webhookId: string };
            query?: { event?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: { event?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get webhook statistics
Description
Get the statistics for a specific webhook.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: { event?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlywebhookId: string
 Description
 ID of the webhook
 - Optional Readonlyquery?: { event?: string }
 - Optional Readonlyevent?: string
 Description
 The string ID of a specific event to retrieve the last invocation for. May be empty, in which case all events are considered
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook invocation dataset.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to get webhook statistics in the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist, or the webhook does not exist in the repository.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics/summary`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics/summary": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string; webhookId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get webhook statistics summary
Description
Get the statistics summary for a specific webhook.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; webhookId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlywebhookId: string
 Description
 ID of the webhook
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook invocation dataset.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to get webhook statistics summary in the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository does not exist, or the webhook does not exist in the repository.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/search`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/search": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { event?: string; scopeType?: string; statistics?: boolean };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { event?: string; scopeType?: string; statistics?: boolean }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Search webhooks
Description
Search webhooks in this repository and parent project. This endpoint returns a superset of the results returned by the /webhooks endpoint because it allows filtering by project scope too, not just repository webhooks.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { event?: string; scopeType?: string; statistics?: boolean }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { event?: string; scopeType?: string; statistics?: boolean }
 - Optional Readonlyevent?: string
 Description
 List of com.atlassian.webhooks.WebhookEvent ids to filter for
 - Optional ReadonlyscopeType?: string
 Description
 Scopes to filter by. This parameter can be specified once e.g. "scopeType=repository", or twice e.g. "scopeType=repository&scopeType=project", to filter by more than one scope level.
 - Optional Readonlystatistics?: boolean
 Description
 true if statistics should be provided for all found webhooks
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of webhooks.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to find webhooks in the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/test`

"/api/latest/projects/{projectKey}/repos/{repositorySlug}/webhooks/test": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                sslVerificationRequired?: string;
                url?: string;
                webhookId?: number;
            };
        };
        requestBody?: {
            content: {
                "application/json": { password?: string; username?: string };
            };
        };
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { sslVerificationRequired?: string; url?: string; webhookId?: number; }; }; requestBody?: { content: { "application/json": { password?: string; username?: string }; }; }; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Test webhook
Description
Test connectivity to a specific endpoint.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { sslVerificationRequired?: string; url?: string; webhookId?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { sslVerificationRequired?: string; url?: string; webhookId?: number }
 - Optional ReadonlysslVerificationRequired?: string
 Description
 Whether SSL verification is required for the specified webhook URL. Default value is true.
 - Optional Readonlyurl?: string
 Description
 The url in which to connect to
 - Optional ReadonlywebhookId?: number
- Optional ReadonlyrequestBody?: { content: { "application/json": { password?: string; username?: string } } }
 Description
 Basic authentication credentials, if required.
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to test a connection.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/secret-scanning/allowlist`

"/api/latest/projects/{projectKey}/secret-scanning/allowlist": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: {
                filter?: string;
                limit?: number;
                order?: "NAME_ASC" | "NAME_DESC";
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            id?: number;
                            lineRegex?: string;
                            name?: string;
                            pathRegex?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find project secret scanning allowlist rules
Description
Find project secret scanning allowlist rules by filtering.
Project **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }
 - Optional Readonlyfilter?: string
 Description
 Filter names by the provided text
 Example
 Access
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyorder?: "NAME_ASC" | "NAME_DESC"
 Description
 Order by
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Page of allowlist rules
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was not correctly formed allowlist rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to view project allowlist rules
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create project secret scanning allowlist rule
Description
Create a new project level secret scanning allowlist rule. Project allowlist rules are used when scanning all non exempt repositories in the provided project.
Project **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }
 Description
 Allowlist rule to create, either the line regular expression or the path regular expression must be present
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The created allowlist rule
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed allowlist rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to create project allowlist rules.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/secret-scanning/allowlist/{id}`

"/api/latest/projects/{projectKey}/secret-scanning/allowlist/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a project secret scanning allowlist rule
Description
Delete a project secret scanning allowlist rule with the provided ID.
Project **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The allowlist rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 Empty response indicating that the rule was deleted, or not found at this location
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to delete project rules
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a project secret scanning allowlist rule
Description
Get a project secret scanning allowlist rule by ID.
Project **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The allowlist rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested allowlist rule
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to view project allowlist rules
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested allowlist rules was not found
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Edit an existing project secret scanning allowlist rule
Description
Edit a project secret scanning allowlist rule.
Project **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The allowlist rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated allowlist rule
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed allowlist rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to modify project allowlist rules
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/secret-scanning/exempt`

"/api/latest/projects/{projectKey}/secret-scanning/exempt": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: number;
                order?: "NAME_ASC" | "NAME_DESC";
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            origin?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            partition?: number;
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            public?: boolean;
                            relatedLinks?: Record<(...), (...)>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: { "*/*": readonly { projectKey?: string; slug?: string }[] };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find repos exempt from secret scanning for a project
Description
Find repositories exempt from secret scanning in a project
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyorder?: "NAME_ASC" | "NAME_DESC"
 Description
 Order by project name followed by repository name either ascending or descending, defaults to ascending.
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Page of repositories
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to search exempt repositories for this project
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "*/*": readonly { projectKey?: string; slug?: string }[] }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Bulk exempt repos from secret scanning
Description
Bulk exempt a list of repositories from being scanned for secrets. User must be have PROJECT ADMIN permissions.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "*/*": readonly { projectKey?: string; slug?: string }[] } }
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 All requested repositories were made exempt
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to exempt a repository from secret scanning. No repositories were made exempt.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/secret-scanning/rules`

"/api/latest/projects/{projectKey}/secret-scanning/rules": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: {
                filter?: string;
                limit?: number;
                order?: "NAME_ASC" | "NAME_DESC";
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            id?: number;
                            lineRegex?: string;
                            name?: string;
                            pathRegex?: string;
                            scope?: { resourceId?: ...; type?: ... };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find project secret scanning rules
Description
Find project secret scanning rules by filtering.
Project **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }
 - Optional Readonlyfilter?: string
 Description
 Filter names by the provided text
 Example
 Access
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyorder?: "NAME_ASC" | "NAME_DESC"
 Description
 Order by
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Page of rules
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was not correctly formed rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to view project rules
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create project secret scanning rule
Description
Create a new project level secret scanning rule. Project rules are used when scanning all non exempt repositories in the provided project.
Project **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }
 Description
 Rule to create, either the line regular expression or the path regular expression must be present
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The created rule
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to create project rules.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/secret-scanning/rules/{id}`

"/api/latest/projects/{projectKey}/secret-scanning/rules/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a project secret scanning rule
Description
Delete a project secret scanning rule with the provided ID.
Project **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 Empty response indicating that the rule was deleted, or not found at this location
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to delete project rules
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a project secret scanning rule
Description
Get a project secret scanning rule by ID.
Project **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested rule
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to view project rules
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested rules was not found
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Edit an existing project secret scanning rule
Description
Edit a project secret scanning rule.
Project **Admin** is required
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The rule id.
 Example
 7
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated rule
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to modify project rules
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings-restriction`

"/api/latest/projects/{projectKey}/settings-restriction": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query: { componentKey?: string; featureKey: string; namespace: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query: { componentKey?: string; featureKey: string; namespace: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        componentKey?: string;
                        featureKey?: string;
                        namespace?: string;
                        processedState?: | "FAILED"
                        | "IN_PROGRESS"
                        | "PROCESSED"
                        | "UNPROCESSED";
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    componentKey?: string;
                    featureKey: string;
                    namespace: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        componentKey?: string;
                        featureKey?: string;
                        namespace?: string;
                        processedState?: | "FAILED"
                        | "IN_PROGRESS"
                        | "PROCESSED"
                        | "UNPROCESSED";
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query: { componentKey?: string; featureKey: string; namespace: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Stop enforcing project restriction
Description
Delete a specified project settings restriction.
If a restriction does not exist for the specified project, namespace, featureKey, and componentKey, the request will be ignored and a 204 response will be returned. The authenticated user must have **PROJECT_ADMIN** permission for the target project to delete a settings restriction.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query: { componentKey?: string; featureKey: string; namespace: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Readonlyquery: { componentKey?: string; featureKey: string; namespace: string }
 - Optional ReadonlycomponentKey?: string
 Description
 A key to uniquely identify individually restrictable subcomponents of a feature within the provided feature key and namespace
 - ReadonlyfeatureKey: string
 Description
 A key to uniquely identify the feature within the provided namespace
 - Readonlynamespace: string
 Description
 A namespace used to identify the provider of the feature
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The specified settings restriction was successfully deleted or there were no existing restrictions that match the specified criteria.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings restriction was not deleted because the request was invalid. Possible issues include:
 - The namespace was not provided, or longer than 255 characters - The featureKey was not provided, or longer than 255 characters - The provided componentKey was fewer than 2 characters, or longer than 255 characters
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete a settings restriction
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query: { componentKey?: string; featureKey: string; namespace: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { componentKey?: string; featureKey?: string; namespace?: string; processedState?: "FAILED" | "IN_PROGRESS" | "PROCESSED" | "UNPROCESSED"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get enforcing project setting
Description
Get a specified project settings restriction for the given namespace, feature key and component key. Note that not providing the component key will not return restrictions for the namespace and feature key with a component key set.
The authenticated user must have **PROJECT_VIEW** permission for the target project to retrieve a settings restriction.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query: { componentKey?: string; featureKey: string; namespace: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Readonlyquery: { componentKey?: string; featureKey: string; namespace: string }
 - Optional ReadonlycomponentKey?: string
 Description
 The component key to uniquely identify individually restrictable subcomponents of a feature within the provided feature key and namespace
 - ReadonlyfeatureKey: string
 Description
 The feature key to uniquely identify the feature within the provided namespace
 - Readonlynamespace: string
 Description
 The namespace used to identify the provider of the feature
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { componentKey?: string; featureKey?: string; namespace?: string; processedState?: "FAILED" | "IN_PROGRESS" | "PROCESSED" | "UNPROCESSED"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { componentKey?: string; featureKey?: string; namespace?: string; processedState?: "FAILED" | "IN_PROGRESS" | "PROCESSED" | "UNPROCESSED"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings restriction associated with the provided namespace and feature key
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings restriction could not be retrieved because the provided parameters were invalid. Possible issues include:
 - The namespace was not provided, or longer than 255 characters - The featureKey was not provided, or longer than 255 characters - The provided componentKey was fewer than 2 characters, or longer than 255 characters
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve a settings restriction
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, or settings restriction does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody: { content: { "application/json": { componentKey?: string; featureKey: string; namespace: string; }; }; }; responses: { "200": { content: { "application/json": { componentKey?: string; featureKey?: string; namespace?: string; processedState?: "FAILED" | "IN_PROGRESS" | "PROCESSED" | "UNPROCESSED"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Enforce project restriction
Description
Create a new project settings restriction for the given project.
The authenticated user must have **PROJECT_ADMIN** permission for the target project to create a settings restriction.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "application/json": { componentKey?: string; featureKey: string; namespace: string; }; }; }
 Description
 The project settings restriction to create
- Readonlyresponses: { "200": { content: { "application/json": { componentKey?: string; featureKey?: string; namespace?: string; processedState?: "FAILED" | "IN_PROGRESS" | "PROCESSED" | "UNPROCESSED"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { componentKey?: string; featureKey?: string; namespace?: string; processedState?: "FAILED" | "IN_PROGRESS" | "PROCESSED" | "UNPROCESSED"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings restriction was successfully created
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings restriction was not created because the request was invalid. Possible issues include:
 - The namespace was not provided, or longer than 255 characters - The featureKey was not provided, or longer than 255 characters - The provided componentKey was fewer than 2 characters, or longer than 255 characters
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create a settings restriction
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A settings restriction with the same namespace, featureKey and componentKey already exists on this project
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings-restriction/all`

"/api/latest/projects/{projectKey}/settings-restriction/all": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query: {
                featureKey: string;
                limit?: number;
                namespace: string;
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            componentKey?: string;
                            featureKey?: string;
                            namespace?: string;
                            processedState?: | "FAILED"
                            | "IN_PROGRESS"
                            | "PROCESSED"
                            | "UNPROCESSED";
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query: { featureKey: string; limit?: number; namespace: string; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { componentKey?: string; featureKey?: string; namespace?: string; processedState?: | "FAILED" | "IN_PROGRESS" | "PROCESSED" | "UNPROCESSED"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all enforcing project settings
Description
Get all project settings restrictions for the given namespace and feature key, including those with a component key set.
The authenticated user must have **PROJECT_VIEW** permission for the target project to retrieve a settings restrictions.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query: { featureKey: string; limit?: number; namespace: string; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Readonlyquery: { featureKey: string; limit?: number; namespace: string; start?: number }
 - ReadonlyfeatureKey: string
 Description
 A key to uniquely identify the feature within the provided namespace
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Readonlynamespace: string
 Description
 A namespace used to identify the provider of the feature
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { componentKey?: string; featureKey?: string; namespace?: string; processedState?: "FAILED" | "IN_PROGRESS" | "PROCESSED" | "UNPROCESSED"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { componentKey?: string; featureKey?: string; namespace?: string; processedState?: "FAILED" | "IN_PROGRESS" | "PROCESSED" | "UNPROCESSED"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of settings restrictions associated with the provided namespace and feature key
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings restrictions could not be retrieved because the provided parameters were invalid. Possible issues include:
 - The namespace was not provided, or longer than 255 characters - The featureKey was not provided, or longer than 255 characters
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve project settings restrictions
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings/auto-decline`

"/api/latest/projects/{projectKey}/settings/auto-decline": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        enabled?: boolean;
                        inactivityWeeks?: number;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": { enabled?: boolean; inactivityWeeks?: number };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        enabled?: boolean;
                        inactivityWeeks?: number;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete auto decline settings
Description
Delete auto decline settings for the supplied project.
The authenticated user must have PROJECT_ADMIN permission for this project to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The auto decline settings have been deleted successfully.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the auto decline settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get auto decline settings
Description
Retrieves the auto decline settings for the supplied project. Default settings are returned if no explicit settings have been set for the project.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The auto decline settings
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the auto decline settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number }; }; }; responses: { "200": { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create/Update auto decline settings
Description
Creates or updates the auto decline settings for the supplied project.
The authenticated user must have PROJECT_ADMIN permission for this project to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number }; }; }
 Description
 The settings to create or update
- Readonlyresponses: { "200": { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { enabled?: boolean; inactivityWeeks?: number; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The auto decline settings
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 inactivityWeeks was not one of 1, 2, 4, 8, or, 12, or the enabled parameter was not included in the request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create or update the auto decline settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings/auto-merge`

"/api/latest/projects/{projectKey}/settings/auto-merge": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        enabled?: boolean;
                        restrictionState?: | "NONE"
                        | "RESTRICTED_MODIFIABLE"
                        | "RESTRICTED_UNMODIFIABLE";
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    enabled?: boolean;
                    restrictionAction?: "CREATE"
                    | "DELETE"
                    | "NONE";
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        enabled?: boolean;
                        restrictionState?: | "NONE"
                        | "RESTRICTED_MODIFIABLE"
                        | "RESTRICTED_UNMODIFIABLE";
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete pull request auto-merge settings
Description
Deletes pull request auto-merge settings for the supplied project.
The authenticated user must have PROJECT_ADMIN permission for this project to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The pull request auto-merge settings
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the pull request auto-merge settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get pull request auto-merge settings
Description
Retrieves the pull request auto-merge settings for the supplied project. Default settings will be returned if no explicit settings have been set for the project
The authenticated user must have PROJECT_VIEW permission for this project to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request auto-merge settings
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the pull request auto-merge settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { enabled?: boolean; restrictionAction?: "CREATE" | "DELETE" | "NONE"; }; }; }; responses: { "200": { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create or update the pull request auto-merge settings
Description
Creates or updates the pull request auto-merge settings for the supplied project, and applies the restriction action specified in the request.
The authenticated user must have PROJECT_ADMIN permission for this project to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { enabled?: boolean; restrictionAction?: "CREATE" | "DELETE" | "NONE"; }; }; }
 Description
 The settings to create or update
- Readonlyresponses: { "200": { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { enabled?: boolean; restrictionState?: | "NONE" | "RESTRICTED_MODIFIABLE" | "RESTRICTED_UNMODIFIABLE"; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The pull request auto-merge settings
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The 'enabled' and 'restrictionAction' fields were not provided correctly.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create or update the pull request auto-merge settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings/hooks`

"/api/latest/projects/{projectKey}/settings/hooks": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: {
                limit?: number;
                start?: number;
                type?: "POST_RECEIVE" | "PRE_RECEIVE";
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            configured?: boolean;
                            details?: {
                                configFormKey?: ...;
                                description?: ...;
                                key?: ...;
                                name?: ...;
                                supportedScopes?: ...;
                                type?: ...;
                                version?: ...;
                            };
                            enabled?: boolean;
                            scope?: { resourceId?: ...; type?: ... };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; start?: number; type?: "POST_RECEIVE" | "PRE_RECEIVE"; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { configured?: boolean; details?: { configFormKey?: ...; description?: ...; key?: ...; name?: ...; supportedScopes?: ...; type?: ...; version?: ...; }; enabled?: boolean; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository hooks
Description
Retrieve a page of repository hooks for this project.
The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; start?: number; type?: "POST_RECEIVE" | "PRE_RECEIVE"; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { limit?: number; start?: number; type?: "POST_RECEIVE" | "PRE_RECEIVE" }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlytype?: "POST_RECEIVE" | "PRE_RECEIVE"
 Description
 The optional type to filter by.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { configured?: boolean; details?: { configFormKey?: ...; description?: ...; key?: ...; name?: ...; supportedScopes?: ...; type?: ...; version?: ...; }; enabled?: boolean; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { configured?: boolean; details?: { configFormKey?: ...; description?: ...; key?: ...; name?: ...; supportedScopes?: ...; type?: ...; version?: ...; }; enabled?: boolean; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of repository hooks with their associated enabled state.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the hooks.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings/hooks/{hookKey}`

"/api/latest/projects/{projectKey}/settings/hooks/{hookKey}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { hookKey: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        configured?: boolean;
                        details?: {
                            configFormKey?: string;
                            description?: string;
                            key?: string;
                            name?: string;
                            supportedScopes?: readonly ((...) | (...) | (...))[];
                            type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
                            version?: string;
                        };
                        enabled?: boolean;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a repository hook
Description
Retrieve a repository hook for this project.
The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { hookKey: string; projectKey: string }
 - ReadonlyhookKey: string
 Description
 The hook key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Returns the repository hooks with their associated enabled state for the supplied hookKey.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to enable the hook.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository hook does not exist for the given project, or the project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings/hooks/{hookKey}/enabled`

"/api/latest/projects/{projectKey}/settings/hooks/{hookKey}/enabled": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { hookKey: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        configured?: boolean;
                        details?: {
                            configFormKey?: string;
                            description?: string;
                            key?: string;
                            name?: string;
                            supportedScopes?: readonly ((...) | (...) | (...))[];
                            type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
                            version?: string;
                        };
                        enabled?: boolean;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: { "Content-Length"?: number };
            path: { hookKey: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        configured?: boolean;
                        details?: {
                            configFormKey?: string;
                            description?: string;
                            key?: string;
                            name?: string;
                            supportedScopes?: readonly ((...) | (...) | (...))[];
                            type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE";
                            version?: string;
                        };
                        enabled?: boolean;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Disable repository hook
Description
Disable a repository hook for this project.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { hookKey: string; projectKey: string }
 - ReadonlyhookKey: string
 Description
 The hook key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository hooks with their associated enabled state for the supplied hookKey.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to disable the hook.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project or hook does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: { "Content-Length"?: number }; path: { hookKey: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Enable repository hook
Description
Enable a repository hook for this project and optionally apply new configuration.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource. A JSON document may be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.
- Readonlyparameters: { cookie?: undefined; header?: { "Content-Length"?: number }; path: { hookKey: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: { "Content-Length"?: number }
 - Optional ReadonlyContent-Length?: number
 Description
 The content length.
 - Readonlypath: { hookKey: string; projectKey: string }
 - ReadonlyhookKey: string
 Description
 The hook key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { configured?: boolean; details?: { configFormKey?: string; description?: string; key?: string; name?: string; supportedScopes?: readonly ((...) | (...) | (...))[]; type?: "POST_RECEIVE" | "PRE_PULL_REQUEST_MERGE" | "PRE_RECEIVE"; version?: string; }; enabled?: boolean; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository hooks with their associated enabled state for the supplied hookKey.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings specified are invalid.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to enable the hook.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project or hook does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings/hooks/{hookKey}/settings`

"/api/latest/projects/{projectKey}/settings/hooks/{hookKey}/settings": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { hookKey: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        booleanValue?: boolean;
                        doubleValue?: number;
                        integerValue?: number;
                        longValue?: number;
                        stringValue?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { hookKey: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    booleanValue?: boolean;
                    doubleValue?: number;
                    integerValue?: number;
                    longValue?: number;
                    stringValue?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        booleanValue?: boolean;
                        doubleValue?: number;
                        integerValue?: number;
                        longValue?: number;
                        stringValue?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository hook settings
Description
Retrieve the settings for a repository hook for this project.
The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { hookKey: string; projectKey: string }
 - ReadonlyhookKey: string
 Description
 The hook key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings for the hook.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the hook settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project or hook does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; }; responses: { "200": { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update repository hook settings
Description
Modify the settings for a repository hook for this project.
The service will reject any settings which are too large, the current limit is 32KB once serialized. The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource. A JSON document can be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { hookKey: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { hookKey: string; projectKey: string }
 - ReadonlyhookKey: string
 Description
 The complete module key of the hook module.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; }
 Description
 The raw settings.
- Readonlyresponses: { "200": { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { booleanValue?: boolean; doubleValue?: number; integerValue?: number; longValue?: number; stringValue?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings for the hook.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The settings specified are invalid.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to modify the hook settings.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project or hook does not exist.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings/pull-requests/{scmId}`

"/api/latest/projects/{projectKey}/settings/pull-requests/{scmId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; scmId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        mergeConfig?: {
                            commitMessageTemplate?: {
                                body?: (...)
                                | (...);
                                title?: (...) | (...);
                            };
                            commitSummaries?: number;
                            defaultStrategy?: {
                                description?: (...)
                                | (...);
                                enabled?: (...) | (...) | (...);
                                flag?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            strategies?: readonly {
                                description?: ...;
                                enabled?: ...;
                                flag?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                            }[];
                            type?: string;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; scmId: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    mergeConfig?: {
                        commitMessageTemplate?: {
                            body?: (...)
                            | (...);
                            title?: (...) | (...);
                        };
                        commitSummaries?: number;
                        defaultStrategy?: {
                            description?: (...)
                            | (...);
                            enabled?: (...) | (...) | (...);
                            flag?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                        };
                        strategies?: readonly {
                            description?: ...;
                            enabled?: ...;
                            flag?: ...;
                            id?: ...;
                            links?: ...;
                            name?: ...;
                        }[];
                        type?: string;
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        mergeConfig?: {
                            commitMessageTemplate?: {
                                body?: (...)
                                | (...);
                                title?: (...) | (...);
                            };
                            commitSummaries?: number;
                            defaultStrategy?: {
                                description?: (...)
                                | (...);
                                enabled?: (...) | (...) | (...);
                                flag?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                            };
                            strategies?: readonly {
                                description?: ...;
                                enabled?: ...;
                                flag?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                            }[];
                            type?: string;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; scmId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get merge strategy
Description
Retrieve the merge strategy configuration for this project and SCM.
The authenticated user must have PROJECT_READ permission for the context repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; scmId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; scmId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyscmId: string
 Description
 The SCM to get strategies for.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The merge configuration of the request project.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to see the request repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; scmId: string }; query?: undefined; }; requestBody?: { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; }; }; }; responses: { "200": { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update merge strategy
Description
Update the pull request merge strategy configuration for this project and SCM.
The authenticated user must have PROJECT_ADMIN permission for the context repository to call this resource. Only the strategies provided will be enabled, the default must be set and included in the set of strategies. An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty "mergeConfig" attribute. i.e: <pre>{ "mergeConfig": {} } </pre> Upon completion of this request, the effective configuration will be the configuration explicitly set for the SCM, or if no such explicit configuration is set then the default configuration will be used.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; scmId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; scmId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyscmId: string
 Description
 The SCM to get strategies for.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; }; }; }
 Description
 The settings.
- Readonlyresponses: { "200": { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { mergeConfig?: { commitMessageTemplate?: { body?: (...) | (...); title?: (...) | (...); }; commitSummaries?: number; defaultStrategy?: { description?: (...) | (...); enabled?: (...) | (...) | (...); flag?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); }; strategies?: readonly { description?: ...; enabled?: ...; flag?: ...; id?: ...; links?: ...; name?: ...; }[]; type?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The merge configuration of the request project.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository pull request merge strategies were not updated due to a validation error.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to administrate the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings/reviewer-groups`

"/api/latest/projects/{projectKey}/settings/reviewer-groups": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            name?: string;
                            scope?: { resourceId?: ...; type?: ... };
                            users?: readonly (...)[];
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    avatarUrl?: string;
                    description?: string;
                    id?: number;
                    name?: string;
                    scope?: {
                        resourceId?: number;
                        type?: "GLOBAL"
                        | "PROJECT"
                        | "REPOSITORY";
                    };
                    users?: readonly {
                        active?: boolean;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL"
                        | "SERVICE";
                    }[];
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        name?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        users?: readonly {
                            active?: boolean;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL"
                            | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: ...; type?: ... }; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all reviewer groups
Description
Retrieve a page of reviewer groups of a given scope.
The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: ...; type?: ... }; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: ...; type?: ... }; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of reviewer group(s) of the provided scope.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project scope supplied does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; }; responses: { "201": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create reviewer group
Description
Create a reviewer group.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; }
 Description
 The reviewer group to be create
- Readonlyresponses: { "201": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created reviewer group.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request is missing a reviewer group name.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project scope supplied does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The new created name already exists.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/settings/reviewer-groups/{id}`

"/api/latest/projects/{projectKey}/settings/reviewer-groups/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        name?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        users?: readonly {
                            active?: boolean;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL"
                            | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    avatarUrl?: string;
                    description?: string;
                    id?: number;
                    name?: string;
                    scope?: {
                        resourceId?: number;
                        type?: "GLOBAL"
                        | "PROJECT"
                        | "REPOSITORY";
                    };
                    users?: readonly {
                        active?: boolean;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL"
                        | "SERVICE";
                    }[];
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        name?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        users?: readonly {
                            active?: boolean;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL"
                            | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete reviewer group
Description
Deletes a reviewer group.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The ID of the reviewer group to be deleted
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The operation was successful.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the reviewer group in this project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Unable to find the supplied reviewer group ID.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get reviewer group
Description
Retrieve a reviewer group.
The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The ID of the reviewer group to be retrieved
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The reviewer group.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The ID supplied does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; }; responses: { "200": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update reviewer group attributes
Description
Update the attributes of a reviewer group.
The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The ID of the reviewer group to be updated
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; }
 Description
 The request containing the attributes of the reviewer group to be updated. Only the attributes to be updated need to be present in this object.
- Readonlyresponses: { "200": { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { avatarUrl?: string; description?: string; id?: number; name?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; users?: readonly { active?: boolean; displayName?: string; emailAddress?: string; id?: number; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of changes.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated attribute does not meet the requirements. E.g. the name exceeds 50 characters, setting name to blank.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project scope supplied does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The new updated name already exists.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/webhooks`

"/api/latest/projects/{projectKey}/webhooks": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { event?: string; statistics?: boolean };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    active?: boolean;
                    configuration?: Record<string, unknown>;
                    credentials?: { password?: string; username?: string };
                    events?: readonly string[];
                    name?: string;
                    scopeType?: string;
                    sslVerificationRequired?: boolean;
                    statistics?: Record<string, unknown>;
                    url?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        configuration?: Record<string, unknown>;
                        credentials?: { password?: string; username?: string };
                        events?: readonly string[];
                        name?: string;
                        scopeType?: string;
                        sslVerificationRequired?: boolean;
                        statistics?: Record<string, unknown>;
                        url?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { event?: string; statistics?: boolean }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find webhooks
Description
Find webhooks in this project.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { event?: string; statistics?: boolean }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { event?: string; statistics?: boolean }
 - Optional Readonlyevent?: string
 Description
 List of com.atlassian.webhooks.WebhookEvent IDs to filter for
 - Optional Readonlystatistics?: boolean
 Description
 true if statistics should be provided for all found webhooks
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of webhooks.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to find webhooks in the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; }; responses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create webhook
Description
Create a webhook for the project specified via the URL.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; }
 Description
 The webhook to be created for this project.
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A created webhook.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The webhook parameters were invalid or not supplied.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create webhooks in the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/webhooks/{webhookId}`

"/api/latest/projects/{projectKey}/webhooks/{webhookId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; webhookId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; webhookId: string };
            query?: { statistics?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        configuration?: Record<string, unknown>;
                        credentials?: { password?: string; username?: string };
                        events?: readonly string[];
                        name?: string;
                        scopeType?: string;
                        sslVerificationRequired?: boolean;
                        statistics?: Record<string, unknown>;
                        url?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; webhookId: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    active?: boolean;
                    configuration?: Record<string, unknown>;
                    credentials?: { password?: string; username?: string };
                    events?: readonly string[];
                    name?: string;
                    scopeType?: string;
                    sslVerificationRequired?: boolean;
                    statistics?: Record<string, unknown>;
                    url?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        configuration?: Record<string, unknown>;
                        credentials?: { password?: string; username?: string };
                        events?: readonly string[];
                        name?: string;
                        scopeType?: string;
                        sslVerificationRequired?: boolean;
                        statistics?: Record<string, unknown>;
                        url?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete webhook
Description
Delete a webhook for the project specified via the URL.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlywebhookId: string
 Description
 The ID of the webhook to be deleted.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The webhook for the project has been deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete webhooks in the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist, or webhook does not exist in this project.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: { statistics?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get webhook
Description
Get a webhook by ID.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: { statistics?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlywebhookId: string
 Description
 ID of the webhook
 - Optional Readonlyquery?: { statistics?: string }
 - Optional Readonlystatistics?: string
 Description
 true if statistics should be provided for the webhook
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to get a webhook in the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project does not exist, or the webhook does not exist in the project.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: undefined; }; requestBody?: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; }; responses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update webhook
Description
Update an existing webhook.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlywebhookId: string
 Description
 Id of the existing webhook
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; }
 Description
 The representation of the updated values for the webhook
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; configuration?: Record<string, unknown>; credentials?: { password?: string; username?: string }; events?: readonly string[]; name?: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: Record<string, unknown>; url?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update a webhook in this project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project does not exist, or the webhook does not exist in the project.
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/webhooks/{webhookId}/latest`

"/api/latest/projects/{projectKey}/webhooks/{webhookId}/latest": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; webhookId: string };
            query?: { event?: string; outcome?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        duration?: number;
                        event?: string;
                        eventScope?: { id?: string; type?: string };
                        finish?: number;
                        id?: number;
                        request?: Record<string, unknown>;
                        result?: Record<string, unknown>;
                        start?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: { event?: string; outcome?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { duration?: number; event?: string; eventScope?: { id?: string; type?: string }; finish?: number; id?: number; request?: Record<string, unknown>; result?: Record<string, unknown>; start?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get last webhook invocation details
Description
Get the latest invocations for a specific webhook.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: { event?: string; outcome?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlywebhookId: string
 Description
 ID of the webhook
 - Optional Readonlyquery?: { event?: string; outcome?: string }
 - Optional Readonlyevent?: string
 Description
 The string ID of a specific event to retrieve the last invocation for.
 - Optional Readonlyoutcome?: string
 Description
 The outcome to filter for. Can be SUCCESS, FAILURE, ERROR. None specified means that the all will be considered
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { duration?: number; event?: string; eventScope?: { id?: string; type?: string }; finish?: number; id?: number; request?: Record<string, unknown>; result?: Record<string, unknown>; start?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { duration?: number; event?: string; eventScope?: { id?: string; type?: string }; finish?: number; id?: number; request?: Record<string, unknown>; result?: Record<string, unknown>; start?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook invocation dataset.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to get webhook invocations in the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist, or the webhook does not exist in the project.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/webhooks/{webhookId}/statistics`

"/api/latest/projects/{projectKey}/webhooks/{webhookId}/statistics": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; webhookId: string };
            query?: { event?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: { event?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get webhook statistics
Description
Get the statistics for a specific webhook.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: { event?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlywebhookId: string
 Description
 ID of the webhook
 - Optional Readonlyquery?: { event?: string }
 - Optional Readonlyevent?: string
 Description
 The string ID of a specific event to retrieve the last invocation for. May be empty, in which case all events are considered
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook invocation dataset.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to get webhook statistics in the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist, or the webhook does not exist in the project.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/webhooks/{webhookId}/statistics/summary`

"/api/latest/projects/{projectKey}/webhooks/{webhookId}/statistics/summary": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; webhookId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get webhook statistics summary
Description
Get the statistics summary for a specific webhook.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; webhookId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; webhookId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlywebhookId: string
 Description
 ID of the webhook
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook invocation dataset.
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 No webhook invocations exist.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to get webhook statistics summary in the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project does not exist, or the webhook does not exist in the project.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/projects/{projectKey}/webhooks/test`

"/api/latest/projects/{projectKey}/webhooks/test": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: {
                sslVerificationRequired?: boolean;
                url?: string;
                webhookId?: number;
            };
        };
        requestBody?: {
            content: {
                "application/json": { password?: string; username?: string };
            };
        };
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { sslVerificationRequired?: boolean; url?: string; webhookId?: number; }; }; requestBody?: { content: { "application/json": { password?: string; username?: string }; }; }; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Test webhook
Description
Test connectivity to a specific endpoint.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { sslVerificationRequired?: boolean; url?: string; webhookId?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { sslVerificationRequired?: boolean; url?: string; webhookId?: number }
 - Optional ReadonlysslVerificationRequired?: boolean
 - Optional Readonlyurl?: string
 Description
 The url in which to connect to
 - Optional ReadonlywebhookId?: number
- Optional ReadonlyrequestBody?: { content: { "application/json": { password?: string; username?: string } } }
 Description
 Basic authentication credentials, if required.
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A webhook.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to test a connection.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/repos`

"/api/latest/repos": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                archived?: string;
                limit?: number;
                name?: string;
                permission?: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE";
                projectkey?: string;
                projectname?: string;
                start?: number;
                state?:
                    | "AVAILABLE"
                    | "INITIALISATION_FAILED"
                    | "INITIALISING"
                    | "OFFLINE";
                visibility?: "public"
                | "private";
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            origin?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            partition?: number;
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            public?: boolean;
                            relatedLinks?: Record<(...), (...)>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { archived?: string; limit?: number; name?: string; permission?: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"; projectkey?: string; projectname?: string; start?: number; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; visibility?: "public" | "private"; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Search for repositories
Description
Retrieve a page of repositories based on query parameters that control the search. See the documentation of the parameters for more details.
This resource is anonymously accessible. Note on permissions. In absence of the <code>permission</code> query parameter the implicit 'read' permission is assumed. Please note that this permission is lower than the <tt>REPO_READ</tt> permission rather than being equal to it. The implicit 'read' permission for a given repository is assigned to any user that has any of the higher permissions, such as <tt>REPO_READ</tt>, as well as to anonymous users if the repository is marked as public. The important implication of the above is that an anonymous request to this resource with a permission level <tt>REPO_READ</tt> is guaranteed to receive an empty list of repositories as a result. For anonymous requests it is therefore recommended to not specify the <tt>permission</tt> parameter at all.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { archived?: string; limit?: number; name?: string; permission?: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"; projectkey?: string; projectname?: string; start?: number; state?: "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; visibility?: "public" | "private"; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { archived?: string; limit?: number; name?: string; permission?: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"; projectkey?: string; projectname?: string; start?: number; state?: "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; visibility?: "public" | "private"; }
 - Optional Readonlyarchived?: string
 Description
 (optional) if specified, this will limit the resulting repository list to ones whose are ACTIVE, ARCHIVED or ALL for both. The match performed is case-insensitive. This filter defaults to ACTIVE when not set. Available since 8.0
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyname?: string
 Description
 (optional) if specified, this will limit the resulting repository list to ones whose name matches this parameter's value. The match performed is case-insensitive and any leading and/or trailing whitespace characters on the name parameter will be stripped.
 - Optional Readonlypermission?: "REPO_ADMIN" | "REPO_READ" | "REPO_WRITE"
 Description
 (optional) if specified, it must be a valid repository permission level name and will limit the resulting repository list to ones that the requesting user has the specified permission level to. If not specified, the default implicit 'read' permission level will be assumed. The currently supported explicit permission values are REPO_READ, REPO_WRITE and REPO_ADMIN.
 - Optional Readonlyprojectkey?: string
 Description
 (optional) if specified, this will limit the resulting repository list to ones whose project's key matches this parameter's value. The match performed is case-insensitive and any leading and/or trailing whitespace characters on the projectKey parameter will be stripped. Available since 8.0
 - Optional Readonlyprojectname?: string
 Description
 (optional) if specified, this will limit the resulting repository list to ones whose project's name matches this parameter's value. The match performed is case-insensitive and any leading and/or trailing whitespace characters on the projectname parameter will be stripped.
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlystate?: "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"
 Description
 (optional) if specified, it must be a valid repository state name and will limit the resulting repository list to ones that are in the specified state. The currently supported explicit state values are AVAILABLE, INITIALISING, INITIALISATION_FAILED and OFFLINE. Available since 5.13
 - Optional Readonlyvisibility?: "public" | "private"
 Description
 (optional) if specified, this will limit the resulting repository list based on the repositories visibility. Valid values are public or private.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of repositories.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The visibility parameter contains an invalid value.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/secret-scanning/exempt`

"/api/latest/secret-scanning/exempt": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: number;
                order?: "NAME_ASC" | "NAME_DESC";
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            origin?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            partition?: number;
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            public?: boolean;
                            relatedLinks?: Record<(...), (...)>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: { "*/*": readonly { projectKey?: string; slug?: string }[] };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find all repos exempt from secret scan
Description
Find all repositories exempt from secret scanning
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyorder?: "NAME_ASC" | "NAME_DESC"
 Description
 Order by project name followed by repository name either ascending or descending, defaults to ascending.
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Page of repositories
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to search exempt repositories globally
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "*/*": readonly { projectKey?: string; slug?: string }[] }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Bulk exempt repos from secret scanning
Description
Bulk exempt a list of repositories from being scanned for secrets. User must be have global ADMIN permissions.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "*/*": readonly { projectKey?: string; slug?: string }[] } }
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 All requested repositories were made exempt
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to exempt a repository from secret scanning. No repositories were made exempt.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 At least one of specified repositories have already been previously made exempt.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/secret-scanning/rules`

"/api/latest/secret-scanning/rules": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                filter?: string;
                limit?: number;
                order?: "NAME_ASC" | "NAME_DESC";
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            id?: number;
                            lineRegex?: string;
                            name?: string;
                            pathRegex?: string;
                            scope?: { resourceId?: ...; type?: ... };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Find global secret scanning rules
Description
Find global secret scanning rules by filtering.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { filter?: string; limit?: number; order?: "NAME_ASC" | "NAME_DESC"; start?: number; }
 - Optional Readonlyfilter?: string
 Description
 Filter by rule name
 Example
 Access
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlyorder?: "NAME_ASC" | "NAME_DESC"
 Description
 Order by
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Page of rules
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed search request, see returned error for more details.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to search global rules
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create global secret scanning rule
Description
Create a new global secret scanning rule. Global rules are used when scanning all non exempt repositories.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- ReadonlyrequestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }
 Description
 Rule to create, either the line regular expression or the path regular expression must be present
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The created rule
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to create global rules
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/secret-scanning/rules/{id}`

"/api/latest/secret-scanning/rules/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "*/*": { lineRegex?: string; name?: string; pathRegex?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        lineRegex?: string;
                        name?: string;
                        pathRegex?: string;
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a global secret scanning rule
Description
Delete a global secret scanning rule with the provided ID
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string }
 - Readonlyid: string
 Description
 The rule id.
 Example
 7
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 Empty response indicating that the rule was deleted
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to delete global rules
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { id: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a global secret scanning rule
Description
Get a global secret scanning rule by ID.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string }
 - Readonlyid: string
 Description
 The rule id.
 Example
 7
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested rule
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to get global rules
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested rule was not found
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: string }; query?: undefined; }; requestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }; responses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Edit a global secret scanning rule.
Description
Edit an existing global secret scanning rule
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string }
 - Readonlyid: string
 Description
 The rule id.
 Example
 7
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "*/*": { lineRegex?: string; name?: string; pathRegex?: string }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; lineRegex?: string; name?: string; pathRegex?: string; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated rule
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a correctly formed rule. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to update global rules
Optional Readonlytrace?: undefined

`Readonly/api/latest/signing/x509-certificates`

"/api/latest/signing/x509-certificates": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": { fingerprint?: string; id?: number };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: { "multipart/form-data": { certificate?: string } };
        };
        responses: {
            "201": {
                content: {
                    "application/json": { fingerprint?: string; id?: number };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { fingerprint?: string; id?: number } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all X.509 certificates
Description
Get all X.509 certificates that have been added to the system.
The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { fingerprint?: string; id?: number } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { fingerprint?: string; id?: number } }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of X.509 certificates
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to get X.509 certificates
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody: { content: { "multipart/form-data": { certificate?: string } }; }; responses: { "201": { content: { "application/json": { fingerprint?: string; id?: number } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create an X.509 certificate
Description
Create an X.509 certificate. This will add the given X.509 certificate to the system. Existing entries will not be overridden if an X.509 certificate already exists. Once added, an X.509 certificate cannot be updated.
The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- ReadonlyrequestBody: { content: { "multipart/form-data": { certificate?: string } } }
 Description
 The multipart form data containing the certificate in a form-field named 'certificate'
- Readonlyresponses: { "201": { content: { "application/json": { fingerprint?: string; id?: number } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { fingerprint?: string; id?: number } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created X.509 certificate
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request did not contain a valid X.509 certificate request. See returned error for more details
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to create X.509 certificates
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/signing/x509-certificates/{id}`

"/api/latest/signing/x509-certificates/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content: {
                    "application/json": { fingerprint?: string; id?: number };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content: { "application/json": { fingerprint?: string; id?: number } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete an X.509 certificate
Description
Delete an X.509 certificate specified by the given ID.
The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string }
 - Readonlyid: string
 Description
 The ID of the X.509 certificate.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content: { "application/json": { fingerprint?: string; id?: number } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content: { "application/json": { fingerprint?: string; id?: number } }; headers: Readonly<Record<string, unknown>>; }
 Description
 An empty response if the X.509 certificate was successfully deleted
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to delete X.509 certificates
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 There is no X.509 certificate with the given ID
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/signing/x509-certificates/crl/{id}`

"/api/latest/signing/x509-certificates/crl/{id}": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update X.509 CRL entries
Description
Update the certificate revocation list (CRL) entries for an issuer X.509 certificate in the system, identified by id. This will add any new revoked X.509 certificates that were issued by the given issuer X.509 certificate.
This endpoint will schedule a request to asynchronously perform the task. Please allow time for the task to complete as it will vary depending on how many CRLs there are to retrieve and process. Note: CRL updates are scheduled to run every 24 hours. You may wish to trigger a refresh manually using this endpoint, otherwise, entries will be updated daily. The authenticated user must have the ADMIN permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string }
 - Readonlyid: string
 Description
 The ID of the issuer certificate.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 Successfully started processing CRLs.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user is not permitted to update X.509 CRL entries
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 There is no X.509 certificate with the given ID
Optional Readonlytrace?: undefined

`Readonly/api/latest/system-signing/configuration`

"/api/latest/system-signing/configuration": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { enabled?: boolean } };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: { content: { "application/json": { enabled?: boolean } } };
        responses: {
            "200": {
                content: { "application/json": { enabled?: boolean } };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { enabled?: boolean } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get system signing configuration
Description
Gets the configuration details for system signing Git objects.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { enabled?: boolean } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { enabled?: boolean } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The configuration details for system signing Git objects
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the configuration details for system signing Git objects.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { enabled?: boolean } } }; responses: { "200": { content: { "application/json": { enabled?: boolean } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update system signing configuration
Description
Updates the configuration for system signing Git objects.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { enabled?: boolean } } }
- Readonlyresponses: { "200": { content: { "application/json": { enabled?: boolean } }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { enabled?: boolean } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated configuration details for system signing Git objects
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The configuration details could not be updated because the provided request was invalid
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the configuration details for system signing Git objects.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/users`

"/api/latest/users": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                filter?: string;
                group?: string;
                permission?: string;
                "permission.N"?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    displayName?: string;
                    email?: string;
                    name?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { filter?: string; group?: string; permission?: string; "permission.N"?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all users
Description
Retrieve a page of users, optionally run through provided filters.
Only authenticated users may call this resource. ### Permission Filters The following three sub-sections list parameters supported for permission filters (where <code>[root]</code> is the root permission filter name, e.g. <code>permission</code>, <code>permission.1</code> etc.) depending on the permission resource. The system determines which filter to apply (Global, Project or Repository permission) based on the `[root]` permission value. E.g. <code>ADMIN</code> is a global permission, <code>PROJECT_ADMIN</code> is a project permission and <code>REPO_ADMIN</code> is a repository permission. Note that the parameters for a given resource will be looked up in the order as they are listed below, that is e.g. for a project resource, if both <code>projectId</code> and <code>projectKey</code> are provided, the system will use <code>projectId</code> for the lookup. <h4>Global permissions</h4> The permission value under <code>[root]</code> is the only required and recognized parameter, as global permissions do not apply to a specific resource. Example valid filter: <code>permission=ADMIN</code>. <h4>Project permissions</h4> - <code>[root]</code>- specifies the project permission - <code>[root].projectId</code> - specifies the project ID to lookup the project by - <code>[root].projectKey</code> - specifies the project key to lookup the project by Example valid filter: <code>permission.1=PROJECT_ADMIN&permission.1.projectKey=TEST_PROJECT</code>. #### Repository permissions - <code>[root]</code>- specifies the repository permission - <code>[root].projectId</code> - specifies the repository ID to lookup the repository by - <code>[root].projectKey</code> and <code>[root].repositorySlug</code>- specifies the project key and repository slug to lookup the repository by; both values need to be provided for this look up to be triggered Example valid filter: <code>permission.2=REPO_ADMIN&permission.2.projectKey=TEST_PROJECT&permission.2.repositorySlug=test_repo</code>.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { filter?: string; group?: string; permission?: string; "permission.N"?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { filter?: string; group?: string; permission?: string; "permission.N"?: string; }
 - Optional Readonlyfilter?: string
 Description
 Return only users, whose username, name or email address contain the filter value
 - Optional Readonlygroup?: string
 Description
 return only users who are members of the given group
 - Optional Readonlypermission?: string
 Description
 The "root" of a permission filter, whose value must be a valid global, project, or repository permission. Additional filter parameters referring to this filter that specify the resource (project or repository) to apply the filter to must be prefixed with permission.. See the section "Permission Filters" above for more details.
 - Optional Readonlypermission.N?: string
 Description
 The "root" of a single permission filter, similar to the permission parameter, where "N" is a natural number starting from 1. This allows clients to specify multiple permission filters, by providing consecutive filters as permission.1, permission.2 etc. Note that the filters numbering has to start with 1 and be continuous for all filters to be processed. The total allowed number of permission filters is 50 and all filters exceeding that limit will be dropped. See the section "Permission Filters" above for more details on how the permission filters are processed.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of users.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The search request was invalid, which may happen for multiple reasons, among others:
 - permission filter for project/repository permission with no parameters specifying the project or repository to apply the filter to - invalid permission name - permission filter for a project/repository permission pointing to a non-existent project or repository The exact reason for the error and - in most cases - the request parameter name that had invalid value - will be provided in the error message.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Authentication failed or was not attempted.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { displayName?: string; email?: string; name?: string; }; }; }; responses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update user details
Description
Update the currently authenticated user's details. The update will always be applied to the currently authenticated user.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { displayName?: string; email?: string; name?: string; }; }; }
 Description
 The user update details
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated user.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Authentication failed or was not attempted.
Optional Readonlytrace?: undefined

`Readonly/api/latest/users/{userSlug}`

"/api/latest/users/{userSlug}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { userSlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { userSlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get user
Description
Retrieve the user matching the supplied userSlug.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { userSlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { userSlug: string }
 - ReadonlyuserSlug: string
 Description
 The user slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user matching the supplied userSlug. Note, this may not be the user's username, always use the user.slug property.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the user.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified user does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/users/{userSlug}/avatar.png`

"/api/latest/users/{userSlug}/avatar.png": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { userSlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { href?: string; name?: string } };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: { "X-Atlassian-Token"?: string };
            path: { userSlug: string };
            query?: undefined;
        };
        requestBody?: { content: { "multipart/form-data": { avatar?: string } } };
        responses: {
            "201": {
                content?: undefined;
                headers: { Location?: string; readonly [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { userSlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { href?: string; name?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete user avatar
Description
Delete the avatar associated to a user.
Users are always allowed to delete their own avatar. To delete someone else's avatar the authenticated user must have global ADMIN permission, or global SYS_ADMIN permission to update a SYS_ADMIN user's avatar.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { userSlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { userSlug: string }
 - ReadonlyuserSlug: string
 Description
 The user slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { href?: string; name?: string } }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { href?: string; name?: string } }; headers: Readonly<Record<string, unknown>>; }
 Description
 The new avatar URL if the local avatar was successfully deleted or did not exist
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The authenticated user has insufficient permissions to delete the specified avatar.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified user does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: { "X-Atlassian-Token"?: string }; path: { userSlug: string }; query?: undefined; }; requestBody?: { content: { "multipart/form-data": { avatar?: string } } }; responses: { "201": { content?: undefined; headers: { Location?: string; readonly [name: string]: unknown }; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update user avatar
Description
Update the avatar for the user with the supplied slug.
This resource accepts POST multipart form data, containing a single image in a form-field named 'avatar'. There are configurable server limits on both the dimensions (1024x1024 pixels by default) and uploaded file size (1MB by default). Several different image formats are supported, but PNG and JPEG are preferred due to the file size limit. This resource has Cross-Site Request Forgery (XSRF) protection. To allow the request to pass the XSRF check the caller needs to send an <code>X-Atlassian-Token</code> HTTP header with the value <code>no-check</code>. An example <a href="http://curl.haxx.se/">curl</a> request to upload an image name 'avatar.png' would be: ``` curl -X POST -u username:password -H "X-Atlassian-Token: no-check" http://example.com/rest/api/latest/users/jdoe/avatar.png -F avatar=@avatar.png ``` Users are always allowed to update their own avatar. To update someone else's avatar the authenticated user must have global ADMIN permission, or global SYS_ADMIN permission to update a SYS_ADMIN user's avatar.
- Readonlyparameters: { cookie?: undefined; header?: { "X-Atlassian-Token"?: string }; path: { userSlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: { "X-Atlassian-Token"?: string }
 - Optional ReadonlyX-Atlassian-Token?: string
 Description
 This resource has Cross-Site Request Forgery (XSRF) protection. To allow the request to pass the XSRF check the caller needs to send an X-Atlassian-Token HTTP header with the value no-check.
 Example
 no-check
 - Readonlypath: { userSlug: string }
 - ReadonlyuserSlug: string
 Description
 The user slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "multipart/form-data": { avatar?: string } } }
 Description
 Multipart form data containing a single image in a form-field named 'avatar'.
- Readonlyresponses: { "201": { content?: undefined; headers: { Location?: string; readonly [name: string]: unknown }; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content?: undefined; headers: { Location?: string; readonly [name: string]: unknown }; }
 Description
 The avatar was uploaded successfully.
 - Optionalcontent?: undefined
 - headers: { Location?: string; readonly [name: string]: unknown }
 - Optional ReadonlyLocation?: string
 Description
 The Location response header which indicates the URL of the avatar.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update the avatar.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified user does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/users/{userSlug}/settings`

"/api/latest/users/{userSlug}/settings": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { userSlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        "boolean key"?: boolean;
                        "long key"?: number;
                        "string key"?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { userSlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    "boolean key"?: boolean;
                    "long key"?: number;
                    "string key"?: string;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { userSlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { "boolean key"?: boolean; "long key"?: number; "string key"?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get user settings
Description
Retrieve a map of user setting key values for a specific user identified by the user slug.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { userSlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { userSlug: string }
 - ReadonlyuserSlug: string
 Description
 The user slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { "boolean key"?: boolean; "long key"?: number; "string key"?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { "boolean key"?: boolean; "long key"?: number; "string key"?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user settings for the specified user slug.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user does not have permission to view the settings of this user.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository, commit, or report does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { userSlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { "boolean key"?: boolean; "long key"?: number; "string key"?: string; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update user settings
Description
Update the entries of a map of user setting key/values for a specific user identified by the user slug.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { userSlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { userSlug: string }
 - ReadonlyuserSlug: string
 Description
 The user slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { "boolean key"?: boolean; "long key"?: number; "string key"?: string; }; }; }
 Description
 A map with the UserSettings entries which must be updated.
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The UserSettings were updated successfully
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not a project administrator.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/api/latest/users/credentials`

"/api/latest/users/credentials": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    oldPassword?: string;
                    password?: string;
                    passwordConfirm?: string;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { oldPassword?: string; password?: string; passwordConfirm?: string; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Set password
Description
Update the currently authenticated user's password.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { oldPassword?: string; password?: string; passwordConfirm?: string; }; }; }
 Description
 The password update details
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The user's password was successfully updated.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed or the old password was incorrect.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Authentication failed or was not attempted.
Optional Readonlytrace?: undefined

`Readonly/audit/latest/notification-settings/retention-config-review`

"/audit/latest/notification-settings/retention-config-review": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Dismiss retention config notification
Description
Dismisses the retention config review notification displayed by the audit plugin for the user that's currently logged in.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 A blank response
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to dismiss the notification.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/branch-permissions/latest/projects/{projectKey}/repos/{repositorySlug}/restrictions`

"/branch-permissions/latest/projects/{projectKey}/repos/{repositorySlug}/restrictions": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                limit?: number;
                matcherId?: string;
                matcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN";
                start?: number;
                type?:
                    | "fast-forward-only"
                    | "no-deletes"
                    | "pull-request-only"
                    | "read-only";
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            accessKeys?: readonly (...)[];
                            groups?: readonly (...)[];
                            id?: number;
                            matcher?: { displayId?: ...; id?: ...; type?: ... };
                            scope?: { resourceId?: ...; type?: ... };
                            type?: string;
                            users?: readonly (...)[];
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/vnd.atl.bitbucket.bulk+json": readonly {
                    accessKeyIds?: readonly number[];
                    accessKeys?: readonly {
                        key?: (...)
                        | (...);
                        permission?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        project?: (...) | (...);
                        repository?: (...) | (...);
                    }[];
                    groupNames?: readonly string[];
                    groups?: readonly string[];
                    id?: number;
                    matcher?: {
                        displayId?: string;
                        id?: string;
                        type?: { id?: ...; name?: ... };
                    };
                    scope?: {
                        resourceId?: number;
                        type?: "GLOBAL"
                        | "PROJECT"
                        | "REPOSITORY";
                    };
                    type?: string;
                    users?: readonly {
                        active?: (...)
                        | (...)
                        | (...);
                        avatarUrl?: (...) | (...);
                        displayName?: (...) | (...);
                        emailAddress?: (...) | (...);
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        slug?: (...) | (...);
                        type?: (...) | (...) | (...);
                    }[];
                    userSlugs?: readonly string[];
                }[];
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        accessKeys?: readonly {
                            key?: {
                                algorithmType?: ...;
                                bitLength?: ...;
                                createdDate?: ...;
                                expiryDays?: ...;
                                fingerprint?: ...;
                                id?: ...;
                                label?: ...;
                                lastAuthenticated?: ...;
                                text?: ...;
                            };
                            permission?: | "ADMIN"
                            | "LICENSED_USER"
                            | "PROJECT_ADMIN"
                            | "PROJECT_CREATE"
                            | "PROJECT_READ"
                            | "PROJECT_VIEW"
                            | "PROJECT_WRITE"
                            | "REPO_ADMIN"
                            | "REPO_CREATE"
                            | "REPO_READ"
                            | "REPO_WRITE"
                            | "SYS_ADMIN"
                            | "USER_ADMIN";
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            repository?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                origin?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                        }[];
                        groups?: readonly string[];
                        id?: number;
                        matcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        type?: string;
                        users?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; matcherId?: string; matcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; start?: number; type?: | "fast-forward-only" | "no-deletes" | "pull-request-only" | "read-only"; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { accessKeys?: readonly (...)[]; groups?: readonly (...)[]; id?: number; matcher?: { displayId?: ...; id?: ...; type?: ... }; scope?: { resourceId?: ...; type?: ... }; type?: string; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Search for ref restrictions
Description
Search for restrictions using the supplied parameters.
The authenticated user must have REPO_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; matcherId?: string; matcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; start?: number; type?: | "fast-forward-only" | "no-deletes" | "pull-request-only" | "read-only"; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; matcherId?: string; matcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; start?: number; type?: | "fast-forward-only" | "no-deletes" | "pull-request-only" | "read-only"; }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional ReadonlymatcherId?: string
 Description
 Matcher id to filter on. Requires the matcherType parameter to be specified also.
 - Optional ReadonlymatcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"
 Description
 Matcher type to filter on
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlytype?: "fast-forward-only" | "no-deletes" | "pull-request-only" | "read-only"
 Description
 Types of restrictions to filter on.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { accessKeys?: readonly (...)[]; groups?: readonly (...)[]; id?: number; matcher?: { displayId?: ...; id?: ...; type?: ... }; scope?: { resourceId?: ...; type?: ... }; type?: string; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { accessKeys?: readonly (...)[]; groups?: readonly (...)[]; id?: number; matcher?: { displayId?: ...; id?: ...; type?: ... }; scope?: { resourceId?: ...; type?: ... }; type?: string; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A response containing a page of restrictions.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not permitted to get restrictions on the provided project
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No restriction exists for the provided ID.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/vnd.atl.bitbucket.bulk+json": readonly { accessKeyIds?: readonly number[]; accessKeys?: readonly { key?: (...) | (...); permission?: | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...); project?: (...) | (...); repository?: (...) | (...); }[]; groupNames?: readonly string[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; userSlugs?: readonly string[]; }[]; }; }; responses: { "200": { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create multiple ref restrictions
Description
Allows creating multiple restrictions at once.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/vnd.atl.bitbucket.bulk+json": readonly { accessKeyIds?: readonly number[]; accessKeys?: readonly { key?: (...) | (...); permission?: | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...); project?: (...) | (...); repository?: (...) | (...); }[]; groupNames?: readonly string[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; userSlugs?: readonly string[]; }[]; }; }
 Description
 The request containing a list of the details of the restrictions to create.
- Readonlyresponses: { "200": { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Response contains the ref restriction that was just created.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to perform this operation.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/branch-permissions/latest/projects/{projectKey}/repos/{repositorySlug}/restrictions/{id}`

"/branch-permissions/latest/projects/{projectKey}/repos/{repositorySlug}/restrictions/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        accessKeys?: readonly {
                            key?: {
                                algorithmType?: ...;
                                bitLength?: ...;
                                createdDate?: ...;
                                expiryDays?: ...;
                                fingerprint?: ...;
                                id?: ...;
                                label?: ...;
                                lastAuthenticated?: ...;
                                text?: ...;
                            };
                            permission?: | "ADMIN"
                            | "LICENSED_USER"
                            | "PROJECT_ADMIN"
                            | "PROJECT_CREATE"
                            | "PROJECT_READ"
                            | "PROJECT_VIEW"
                            | "PROJECT_WRITE"
                            | "REPO_ADMIN"
                            | "REPO_CREATE"
                            | "REPO_READ"
                            | "REPO_WRITE"
                            | "SYS_ADMIN"
                            | "USER_ADMIN";
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            repository?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                origin?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                        }[];
                        groups?: readonly string[];
                        id?: number;
                        matcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        type?: string;
                        users?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a ref restriction
Description
Deletes a restriction as specified by a restriction id.
The authenticated user must have REPO_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The restriction id.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the operation was successful
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not permitted to delete restrictions on the provided project
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a ref restriction
Description
Returns a restriction as specified by a restriction id.
The authenticated user must have REPO_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The restriction id.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A response containing the restriction.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not permitted to get restrictions on the provided project
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No restriction exists for the provided ID.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/branch-permissions/latest/projects/{projectKey}/restrictions`

"/branch-permissions/latest/projects/{projectKey}/restrictions": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: {
                limit?: number;
                matcherId?: string;
                matcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN";
                start?: number;
                type?:
                    | "fast-forward-only"
                    | "no-deletes"
                    | "pull-request-only"
                    | "read-only";
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            accessKeys?: readonly (...)[];
                            groups?: readonly (...)[];
                            id?: number;
                            matcher?: { displayId?: ...; id?: ...; type?: ... };
                            scope?: { resourceId?: ...; type?: ... };
                            type?: string;
                            users?: readonly (...)[];
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/vnd.atl.bitbucket.bulk+json": readonly {
                    accessKeyIds?: readonly number[];
                    accessKeys?: readonly {
                        key?: (...)
                        | (...);
                        permission?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        project?: (...) | (...);
                        repository?: (...) | (...);
                    }[];
                    groupNames?: readonly string[];
                    groups?: readonly string[];
                    id?: number;
                    matcher?: {
                        displayId?: string;
                        id?: string;
                        type?: { id?: ...; name?: ... };
                    };
                    scope?: {
                        resourceId?: number;
                        type?: "GLOBAL"
                        | "PROJECT"
                        | "REPOSITORY";
                    };
                    type?: string;
                    users?: readonly {
                        active?: (...)
                        | (...)
                        | (...);
                        avatarUrl?: (...) | (...);
                        displayName?: (...) | (...);
                        emailAddress?: (...) | (...);
                        id?: (...) | (...);
                        links?: (...) | (...);
                        name?: (...) | (...);
                        slug?: (...) | (...);
                        type?: (...) | (...) | (...);
                    }[];
                    userSlugs?: readonly string[];
                }[];
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        accessKeys?: readonly {
                            key?: {
                                algorithmType?: ...;
                                bitLength?: ...;
                                createdDate?: ...;
                                expiryDays?: ...;
                                fingerprint?: ...;
                                id?: ...;
                                label?: ...;
                                lastAuthenticated?: ...;
                                text?: ...;
                            };
                            permission?: | "ADMIN"
                            | "LICENSED_USER"
                            | "PROJECT_ADMIN"
                            | "PROJECT_CREATE"
                            | "PROJECT_READ"
                            | "PROJECT_VIEW"
                            | "PROJECT_WRITE"
                            | "REPO_ADMIN"
                            | "REPO_CREATE"
                            | "REPO_READ"
                            | "REPO_WRITE"
                            | "SYS_ADMIN"
                            | "USER_ADMIN";
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            repository?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                origin?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                        }[];
                        groups?: readonly string[];
                        id?: number;
                        matcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        type?: string;
                        users?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; matcherId?: string; matcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; start?: number; type?: | "fast-forward-only" | "no-deletes" | "pull-request-only" | "read-only"; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { accessKeys?: readonly (...)[]; groups?: readonly (...)[]; id?: number; matcher?: { displayId?: ...; id?: ...; type?: ... }; scope?: { resourceId?: ...; type?: ... }; type?: string; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Search for ref restrictions
Description
Search for restrictions using the supplied parameters.
The authenticated user must have PROJECT_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; matcherId?: string; matcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; start?: number; type?: | "fast-forward-only" | "no-deletes" | "pull-request-only" | "read-only"; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { limit?: number; matcherId?: string; matcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; start?: number; type?: | "fast-forward-only" | "no-deletes" | "pull-request-only" | "read-only"; }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional ReadonlymatcherId?: string
 Description
 Matcher id to filter on. Requires the matcherType parameter to be specified also.
 - Optional ReadonlymatcherType?: "BRANCH" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"
 Description
 Matcher type to filter on
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlytype?: "fast-forward-only" | "no-deletes" | "pull-request-only" | "read-only"
 Description
 Types of restrictions to filter on.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { accessKeys?: readonly (...)[]; groups?: readonly (...)[]; id?: number; matcher?: { displayId?: ...; id?: ...; type?: ... }; scope?: { resourceId?: ...; type?: ... }; type?: string; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { accessKeys?: readonly (...)[]; groups?: readonly (...)[]; id?: number; matcher?: { displayId?: ...; id?: ...; type?: ... }; scope?: { resourceId?: ...; type?: ... }; type?: string; users?: readonly (...)[]; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A response containing a page of restrictions.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not permitted to get restrictions on the provided project
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No restriction exists for the provided ID.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/vnd.atl.bitbucket.bulk+json": readonly { accessKeyIds?: readonly number[]; accessKeys?: readonly { key?: (...) | (...); permission?: | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...); project?: (...) | (...); repository?: (...) | (...); }[]; groupNames?: readonly string[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; userSlugs?: readonly string[]; }[]; }; }; responses: { "200": { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create multiple ref restrictions
Description
Allows creating multiple restrictions at once.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/vnd.atl.bitbucket.bulk+json": readonly { accessKeyIds?: readonly number[]; accessKeys?: readonly { key?: (...) | (...); permission?: | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...); project?: (...) | (...); repository?: (...) | (...); }[]; groupNames?: readonly string[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; userSlugs?: readonly string[]; }[]; }; }
 Description
 The request containing a list of the details of the restrictions to create.
- Readonlyresponses: { "200": { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Response contains the ref restriction that was just created.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to perform this operation.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/branch-permissions/latest/projects/{projectKey}/restrictions/{id}`

"/branch-permissions/latest/projects/{projectKey}/restrictions/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        accessKeys?: readonly {
                            key?: {
                                algorithmType?: ...;
                                bitLength?: ...;
                                createdDate?: ...;
                                expiryDays?: ...;
                                fingerprint?: ...;
                                id?: ...;
                                label?: ...;
                                lastAuthenticated?: ...;
                                text?: ...;
                            };
                            permission?: | "ADMIN"
                            | "LICENSED_USER"
                            | "PROJECT_ADMIN"
                            | "PROJECT_CREATE"
                            | "PROJECT_READ"
                            | "PROJECT_VIEW"
                            | "PROJECT_WRITE"
                            | "REPO_ADMIN"
                            | "REPO_CREATE"
                            | "REPO_READ"
                            | "REPO_WRITE"
                            | "SYS_ADMIN"
                            | "USER_ADMIN";
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            repository?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                origin?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                        }[];
                        groups?: readonly string[];
                        id?: number;
                        matcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        type?: string;
                        users?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a ref restriction
Description
Deletes a restriction as specified by a restriction id.
The authenticated user must have PROJECT_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The restriction id.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the operation was successful
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not permitted to delete restrictions on the provided project
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a ref restriction
Description
Returns a restriction as specified by a restriction id.
The authenticated user must have PROJECT_ADMIN permission or higher to call this resource. Only authenticated users may call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The restriction id.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { accessKeys?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; groups?: readonly string[]; id?: number; matcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; type?: string; users?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A response containing the restriction.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not permitted to get restrictions on the provided project
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No restriction exists for the provided ID.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/branch-utils/latest/projects/{projectKey}/repos/{repositorySlug}/branches`

"/branch-utils/latest/projects/{projectKey}/repos/{repositorySlug}/branches": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    dryRun?: boolean;
                    endPoint?: string;
                    name?: string;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": { name?: string; startPoint?: string };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        default?: boolean;
                        displayId?: string;
                        id?: string;
                        latestChangeset?: string;
                        latestCommit?: string;
                        type?: unknown;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { dryRun?: boolean; endPoint?: string; name?: string; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete branch
Description
Deletes a branch in the specified repository.
If the branch does not exist, this operation will not raise an error. In other words after calling this resource and receiving a 204 response the branch provided in the request is guaranteed to not exist in the specified repository any more, regardless of its existence beforehand. The optional 'endPoint' parameter of the request may contain a commit ID that the provided ref name is expected to point to. Should the ref point to a different commit ID, a 400 response will be returned with appropriate error details. The authenticated user must have an effective REPO_WRITE permission to call this resource. If branch permissions are set up in the repository, the authenticated user must also have access to the branch name that is to be deleted.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { dryRun?: boolean; endPoint?: string; name?: string; }; }; }
 Description
 Branch delete request
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the branch no longer exists in the repository
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The branch was not deleted because the request was invalid, e.g. no ref name to delete was provided, or the provided ref name points to the default branch in the repository that cannot be deleted
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete a branch. This could be due to insufficient repository permissions, or lack of branch permission for the provided ref name.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody: { content: { "application/json": { name?: string; startPoint?: string } }; }; responses: { "201": { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create branch
Description
Creates a branch in the specified repository.
The authenticated user must have an effective REPO_WRITE permission to call this resource. If branch permissions are set up in the repository, the authenticated user must also have access to the branch name that is to be created.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "application/json": { name?: string; startPoint?: string } } }
- Readonlyresponses: { "201": { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { default?: boolean; displayId?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: unknown; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 JSON representation of the newly created branch
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The branch was not created because the request was invalid, e.g. the provided ref name already existed in the repository, or was not a valid ref name in the repository
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create a branch. This could be due to insufficient repository permissions, or lack of branch permission for the provided ref name
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The branch name overlapped with an existing branch
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/branch-utils/latest/projects/{projectKey}/repos/{repositorySlug}/branches/info/{commitId}`

"/branch-utils/latest/projects/{projectKey}/repos/{repositorySlug}/branches/info/{commitId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            displayId?: string;
                            id?: string;
                            type?: "BRANCH"
                            | "TAG";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { displayId?: string; id?: string; type?: "BRANCH" | "TAG"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "500": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get branch
Description
Gets the branch information associated with a single commit from a given repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { displayId?: string; id?: string; type?: "BRANCH" | "TAG"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "500": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { displayId?: string; id?: string; type?: "BRANCH" | "TAG"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of branch refs associated with the commit
 - Readonly500: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has timed out processing the branch request
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/build-status/latest/commits/{commitId}`

"/build-status/latest/commits/{commitId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string };
            query?: { limit?: number; orderBy?: string; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            buildNumber?: string;
                            createdDate?: number;
                            description?: string;
                            duration?: number;
                            key?: string;
                            name?: string;
                            parent?: string;
                            ref?: string;
                            state?: | "FAILED"
                            | "INPROGRESS"
                            | "SUCCESSFUL"
                            | "UNKNOWN"
                            | "CANCELLED";
                            testResults?: { failed?: ...; skipped?: ...; successful?: ... };
                            updatedDate?: number;
                            url?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    buildNumber?: string;
                    createdDate?: number;
                    description?: string;
                    duration?: number;
                    key?: string;
                    name?: string;
                    parent?: string;
                    ref?: string;
                    state?: | "FAILED"
                    | "INPROGRESS"
                    | "SUCCESSFUL"
                    | "UNKNOWN"
                    | "CANCELLED";
                    testResults?: {
                        failed?: number;
                        skipped?: number;
                        successful?: number;
                    };
                    updatedDate?: number;
                    url?: string;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string }; query?: { limit?: number; orderBy?: string; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { buildNumber?: string; createdDate?: number; description?: string; duration?: number; key?: string; name?: string; parent?: string; ref?: string; state?: | "FAILED" | "INPROGRESS" | "SUCCESSFUL" | "UNKNOWN" | "CANCELLED"; testResults?: { failed?: ...; skipped?: ...; successful?: ... }; updatedDate?: number; url?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get build statuses for commit
Deprecated
Description
Gets build statuses associated with a commit.
Deprecated in 7.14, please use the repository based builds resource instead.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string }; query?: { limit?: number; orderBy?: string; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string }
 - ReadonlycommitId: string
 Description
 Full SHA1 of the commit (ex: e00cf62997a027bbf785614a93e2e55bb331d268)
 - Optional Readonlyquery?: { limit?: number; orderBy?: string; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional ReadonlyorderBy?: string
 Description
 How the results should be ordered. Options are NEWEST, OLDEST, STATUS
 Example
 newest, oldest, or status
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { buildNumber?: string; createdDate?: number; description?: string; duration?: number; key?: string; name?: string; parent?: string; ref?: string; state?: | "FAILED" | "INPROGRESS" | "SUCCESSFUL" | "UNKNOWN" | "CANCELLED"; testResults?: { failed?: ...; skipped?: ...; successful?: ... }; updatedDate?: number; url?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { buildNumber?: string; createdDate?: number; description?: string; duration?: number; key?: string; name?: string; parent?: string; ref?: string; state?: "FAILED" | "INPROGRESS" | "SUCCESSFUL" | "UNKNOWN" | "CANCELLED"; testResults?: { failed?: ...; skipped?: ...; successful?: ... }; updatedDate?: number; url?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A Page of build statuses associated with the commit (limited to the most recent 100 build statuses associated with the commit)
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user is not authenticated or does not have the LICENSED permission.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string }; query?: undefined; }; requestBody?: { content: { "application/json": { buildNumber?: string; createdDate?: number; description?: string; duration?: number; key?: string; name?: string; parent?: string; ref?: string; state?: "FAILED" | "INPROGRESS" | "SUCCESSFUL" | "UNKNOWN" | "CANCELLED"; testResults?: { failed?: number; skipped?: number; successful?: number }; updatedDate?: number; url?: string; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create build status for commit
Deprecated
Description
Associates a build status with a commit.The state, the key and the url fields are mandatory. The name anddescription fields are optional.All fields (mandatory or optional) are limited to 255 characters, except for the url,which is limited to 450 characters.Supported values for the state are SUCCESSFUL, FAILEDand INPROGRESS.The authenticated user must have LICENSED permission or higher to call this resource.
Deprecated in 7.14, please use the repository based builds resource instead.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string }
 - ReadonlycommitId: string
 Description
 full SHA1 of the commit
 Example
 e00cf62997a027bbf785614a93e2e55bb331d268
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { buildNumber?: string; createdDate?: number; description?: string; duration?: number; key?: string; name?: string; parent?: string; ref?: string; state?: "FAILED" | "INPROGRESS" | "SUCCESSFUL" | "UNKNOWN" | "CANCELLED"; testResults?: { failed?: number; skipped?: number; successful?: number }; updatedDate?: number; url?: string; }; }; }
 Description
 build status to associate with the commit
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response if the build status was successfully stored
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 An error message if the commitId is not a full 40-characters SHA1, if the build status has a missing mandatory field or if the fields are too large
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user is not authenticated or does not have the LICENSED permission
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/build-status/latest/commits/stats`

"/build-status/latest/commits/stats": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: { content: { "application/json": readonly string[] } };
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": readonly string[] } }; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get build status statistics for multiple commits
Description
Produces a list of the build statistics for multiple commits. Commits without any builds associated with them will not be returned. For example if the commit e00cf62997a027bbf785614a93e2e55bb331d268 does not have any build statuses associated with it, it will not be present in the response.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": readonly string[] } }
 Description
 full SHA1 of each commit
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The number of successful/failed/in-progress/cancelled/unknown builds for each commit (with the caveat that the commits without any builds associated with them will not be present in the response)
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user is not authenticated or does not have the LICENSED permission
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/build-status/latest/commits/stats/{commitId}`

"/build-status/latest/commits/stats/{commitId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string };
            query?: { includeUnique?: boolean };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        cancelled?: number;
                        failed?: number;
                        inProgress?: number;
                        successful?: number;
                        unknown?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string }; query?: { includeUnique?: boolean }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { cancelled?: number; failed?: number; inProgress?: number; successful?: number; unknown?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get build status statistics for commit
Description
Gets statistics regarding the builds associated with a commit
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string }; query?: { includeUnique?: boolean }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string }
 - ReadonlycommitId: string
 Description
 full SHA1 of the commit
 Example
 e00cf62997a027bbf785614a93e2e55bb331d268
 - Optional Readonlyquery?: { includeUnique?: boolean }
 - Optional ReadonlyincludeUnique?: boolean
 Description
 include a unique build result if there is either only one failed build, only one in-progress build or only one successful build
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { cancelled?: number; failed?: number; inProgress?: number; successful?: number; unknown?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { cancelled?: number; failed?: number; inProgress?: number; successful?: number; unknown?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The number of successful/failed/in-progress/cancelled/unknown builds for the commit
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user is not authenticated or does not have the LICENSED permission.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/comment-likes/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}/reactions/{emoticon}`

"/comment-likes/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}/reactions/{emoticon}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                commitId: string;
                emoticon: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                commitId: string;
                emoticon: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        comment?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly {
                                anchor?: ...;
                                anchored?: ...;
                                author?: ...;
                                comments?: ...;
                                createdDate?: ...;
                                html?: ...;
                                id?: ...;
                                parent?: ...;
                                pending?: ...;
                                properties?: ...;
                                reply?: ...;
                                resolvedDate?: ...;
                                resolver?: ...;
                                severity?: ...;
                                state?: ...;
                                text?: ...;
                                threadResolved?: ...;
                                threadResolvedDate?: ...;
                                threadResolver?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            }[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            parent?: {
                                anchor?: (...)
                                | (...);
                                anchored?: (...) | (...) | (...);
                                author?: (...) | (...);
                                comments?: (...) | (...);
                                createdDate?: (...) | (...);
                                html?: (...) | (...);
                                id?: (...) | (...);
                                pending?: (...) | (...) | (...);
                                properties?: (...) | (...);
                                reply?: (...) | (...) | (...);
                                resolvedDate?: (...) | (...);
                                resolver?: (...) | (...);
                                severity?: (...) | (...);
                                state?: (...) | (...);
                                text?: (...) | (...);
                                threadResolved?: (...) | (...) | (...);
                                threadResolvedDate?: (...) | (...);
                                threadResolver?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        emoticon?: { shortcut?: string; url?: string; value?: string };
                        user?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; commitId: string; emoticon: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; }; }
Remove a reaction from comment
Description
Remove an emoticon reaction from a comment
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; commitId: string; emoticon: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; commitId: string; emoticon: string; projectKey: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The comment id
 - ReadonlycommitId: string
 Description
 The commit id
 - Readonlyemoticon: string
 Description
 The emoticon to remove
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>> } }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The added reaction
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; commitId: string; emoticon: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { comment?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; parent?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: (...) | (...); anchored?: (...) | (...) | (...); author?: (...) | (...); comments?: (...) | (...); createdDate?: (...) | (...); html?: (...) | (...); id?: (...) | (...); pending?: (...) | (...) | (...); properties?: (...) | (...); reply?: (...) | (...) | (...); resolvedDate?: (...) | (...); resolver?: (...) | (...); severity?: (...) | (...); state?: (...) | (...); text?: (...) | (...); threadResolved?: (...) | (...) | (...); threadResolvedDate?: (...) | (...); threadResolver?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; emoticon?: { shortcut?: string; url?: string; value?: string }; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
React to a comment
Description
Add an emoticon reaction to a comment
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; commitId: string; emoticon: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; commitId: string; emoticon: string; projectKey: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The comment id
 - ReadonlycommitId: string
 Description
 The commit id
 - Readonlyemoticon: string
 Description
 The emoticon to add
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { comment?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; parent?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: (...) | (...); anchored?: (...) | (...) | (...); author?: (...) | (...); comments?: (...) | (...); createdDate?: (...) | (...); html?: (...) | (...); id?: (...) | (...); pending?: (...) | (...) | (...); properties?: (...) | (...); reply?: (...) | (...) | (...); resolvedDate?: (...) | (...); resolver?: (...) | (...); severity?: (...) | (...); state?: (...) | (...); text?: (...) | (...); threadResolved?: (...) | (...) | (...); threadResolvedDate?: (...) | (...); threadResolver?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; emoticon?: { shortcut?: string; url?: string; value?: string }; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { comment?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; parent?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: (...) | (...); anchored?: (...) | (...) | (...); author?: (...) | (...); comments?: (...) | (...); createdDate?: (...) | (...); html?: (...) | (...); id?: (...) | (...); pending?: (...) | (...) | (...); properties?: (...) | (...); reply?: (...) | (...) | (...); resolvedDate?: (...) | (...); resolver?: (...) | (...); severity?: (...) | (...); state?: (...) | (...); text?: (...) | (...); threadResolved?: (...) | (...) | (...); threadResolvedDate?: (...) | (...); threadResolver?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; emoticon?: { shortcut?: string; url?: string; value?: string }; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The added reaction
Optional Readonlytrace?: undefined

`Readonly/comment-likes/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/reactions/{emoticon}`

"/comment-likes/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/reactions/{emoticon}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                emoticon: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commentId: string;
                emoticon: string;
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        comment?: {
                            anchor?: {
                                diffType?: (...)
                                | (...)
                                | (...)
                                | (...);
                                fileType?: (...) | (...) | (...);
                                fromHash?: (...) | (...);
                                line?: (...) | (...);
                                lineType?: (...) | (...) | (...) | (...);
                                multilineMarker?: (...) | (...);
                                path?: (...) | (...);
                                pullRequest?: (...) | (...);
                                srcPath?: (...) | (...);
                                toHash?: (...) | (...);
                            };
                            anchored?: boolean;
                            author?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            comments?: readonly {
                                anchor?: ...;
                                anchored?: ...;
                                author?: ...;
                                comments?: ...;
                                createdDate?: ...;
                                html?: ...;
                                id?: ...;
                                parent?: ...;
                                pending?: ...;
                                properties?: ...;
                                reply?: ...;
                                resolvedDate?: ...;
                                resolver?: ...;
                                severity?: ...;
                                state?: ...;
                                text?: ...;
                                threadResolved?: ...;
                                threadResolvedDate?: ...;
                                threadResolver?: ...;
                                updatedDate?: ...;
                                version?: ...;
                            }[];
                            createdDate?: number;
                            html?: string;
                            id?: number;
                            parent?: {
                                anchor?: (...)
                                | (...);
                                anchored?: (...) | (...) | (...);
                                author?: (...) | (...);
                                comments?: (...) | (...);
                                createdDate?: (...) | (...);
                                html?: (...) | (...);
                                id?: (...) | (...);
                                pending?: (...) | (...) | (...);
                                properties?: (...) | (...);
                                reply?: (...) | (...) | (...);
                                resolvedDate?: (...) | (...);
                                resolver?: (...) | (...);
                                severity?: (...) | (...);
                                state?: (...) | (...);
                                text?: (...) | (...);
                                threadResolved?: (...) | (...) | (...);
                                threadResolvedDate?: (...) | (...);
                                threadResolver?: (...) | (...);
                                updatedDate?: (...) | (...);
                                version?: (...) | (...);
                            };
                            pending?: boolean;
                            properties?: Record<string, unknown>;
                            reply?: boolean;
                            resolvedDate?: number;
                            resolver?: {
                                active?: (...) | (...) | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            severity?: string;
                            state?: string;
                            text?: string;
                            threadResolved?: boolean;
                            threadResolvedDate?: number;
                            threadResolver?: {
                                active?: (...)
                                | (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                displayName?: (...) | (...);
                                emailAddress?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                slug?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            updatedDate?: number;
                            version?: number;
                        };
                        emoticon?: { shortcut?: string; url?: string; value?: string };
                        user?: {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; emoticon: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; }; }
Remove a reaction from a PR comment
Description
Remove an emoticon reaction from a pull request comment
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; emoticon: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; emoticon: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The comment id.
 - Readonlyemoticon: string
 Description
 The emoticon to remove
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request id.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>> } }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The added reaction
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string; emoticon: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { comment?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; parent?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: (...) | (...); anchored?: (...) | (...) | (...); author?: (...) | (...); comments?: (...) | (...); createdDate?: (...) | (...); html?: (...) | (...); id?: (...) | (...); pending?: (...) | (...) | (...); properties?: (...) | (...); reply?: (...) | (...) | (...); resolvedDate?: (...) | (...); resolver?: (...) | (...); severity?: (...) | (...); state?: (...) | (...); text?: (...) | (...); threadResolved?: (...) | (...) | (...); threadResolvedDate?: (...) | (...); threadResolver?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; emoticon?: { shortcut?: string; url?: string; value?: string }; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
React to a PR comment
Description
Add an emoticon reaction to a pull request comment
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string; emoticon: string; projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string; emoticon: string; projectKey: string; pullRequestId: string; repositorySlug: string; }
 - ReadonlycommentId: string
 Description
 The comment id.
 - Readonlyemoticon: string
 Description
 The emoticon to add
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The pull request id.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { comment?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; parent?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: (...) | (...); anchored?: (...) | (...) | (...); author?: (...) | (...); comments?: (...) | (...); createdDate?: (...) | (...); html?: (...) | (...); id?: (...) | (...); pending?: (...) | (...) | (...); properties?: (...) | (...); reply?: (...) | (...) | (...); resolvedDate?: (...) | (...); resolver?: (...) | (...); severity?: (...) | (...); state?: (...) | (...); text?: (...) | (...); threadResolved?: (...) | (...) | (...); threadResolvedDate?: (...) | (...); threadResolver?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; emoticon?: { shortcut?: string; url?: string; value?: string }; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { comment?: { anchor?: { diffType?: (...) | (...) | (...) | (...); fileType?: (...) | (...) | (...); fromHash?: (...) | (...); line?: (...) | (...); lineType?: (...) | (...) | (...) | (...); multilineMarker?: (...) | (...); path?: (...) | (...); pullRequest?: (...) | (...); srcPath?: (...) | (...); toHash?: (...) | (...); }; anchored?: boolean; author?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; comments?: readonly { anchor?: ...; anchored?: ...; author?: ...; comments?: ...; createdDate?: ...; html?: ...; id?: ...; parent?: ...; pending?: ...; properties?: ...; reply?: ...; resolvedDate?: ...; resolver?: ...; severity?: ...; state?: ...; text?: ...; threadResolved?: ...; threadResolvedDate?: ...; threadResolver?: ...; updatedDate?: ...; version?: ...; }[]; createdDate?: number; html?: string; id?: number; parent?: { anchor?: (...) | (...); anchored?: (...) | (...) | (...); author?: (...) | (...); comments?: (...) | (...); createdDate?: (...) | (...); html?: (...) | (...); id?: (...) | (...); pending?: (...) | (...) | (...); properties?: (...) | (...); reply?: (...) | (...) | (...); resolvedDate?: (...) | (...); resolver?: (...) | (...); severity?: (...) | (...); state?: (...) | (...); text?: (...) | (...); threadResolved?: (...) | (...) | (...); threadResolvedDate?: (...) | (...); threadResolver?: (...) | (...); updatedDate?: (...) | (...); version?: (...) | (...); }; pending?: boolean; properties?: Record<string, unknown>; reply?: boolean; resolvedDate?: number; resolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; severity?: string; state?: string; text?: string; threadResolved?: boolean; threadResolvedDate?: number; threadResolver?: { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }; updatedDate?: number; version?: number; }; emoticon?: { shortcut?: string; url?: string; value?: string }; user?: { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The added reaction
Optional Readonlytrace?: undefined

`Readonly/default-reviewers/latest/projects/{projectKey}/condition`

"/default-reviewers/latest/projects/{projectKey}/condition": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    requiredApprovals?: number;
                    reviewers?: readonly {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<(...), (...)>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    }[];
                    sourceMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            name?: (...) | (...);
                        };
                    };
                    targetMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            name?: (...) | (...);
                        };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        requiredApprovals?: number;
                        reviewers?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        sourceRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                        targetRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; }; responses: { "200": { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create default reviewer
Description
Create a default reviewer pull request condition for the given project.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; }
 Description
 The details needed to create a default reviewer pull request condition.
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The default reviewer pull request condition that was created.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/default-reviewers/latest/projects/{projectKey}/condition/{id}`

"/default-reviewers/latest/projects/{projectKey}/condition/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    requiredApprovals?: number;
                    reviewers?: readonly {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<(...), (...)>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    }[];
                    sourceMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            name?: (...) | (...);
                        };
                    };
                    targetMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            name?: (...) | (...);
                        };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        requiredApprovals?: number;
                        reviewers?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        sourceRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                        targetRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Remove default reviewer
Description
Delete the default reviewer pull request condition associated with the given ID.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The ID of the pull request condition.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the pull request condition was deleted.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 An empty response indicating a pull request condition with the given ID could not be found.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; }; responses: { "200": { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update the default reviewer
Description
Update the default reviewer pull request condition for the given ID.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string }
 - Readonlyid: string
 Description
 The ID of the pull request condition.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; }
 Description
 The new details for the default reviewer pull request condition.
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated default reviewer pull request condition.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed
Optional Readonlytrace?: undefined

`Readonly/default-reviewers/latest/projects/{projectKey}/conditions`

"/default-reviewers/latest/projects/{projectKey}/conditions": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": readonly {
                        id?: number;
                        requiredApprovals?: number;
                        reviewers?: readonly {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        }[];
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        sourceRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: { id?: ...; name?: ... };
                        };
                        targetRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: { id?: ...; name?: ... };
                        };
                    }[];
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": readonly { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; }[]; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get default reviewers
Description
Return a page of default reviewer pull request conditions that have been configured for this project.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": readonly { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; }[]; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": readonly { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; }[]; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The default reviewer pull request conditions associated with the given project.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition`

"/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    requiredApprovals?: number;
                    reviewers?: readonly {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<(...), (...)>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    }[];
                    sourceMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            name?: (...) | (...);
                        };
                    };
                    targetMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            name?: (...) | (...);
                        };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        requiredApprovals?: number;
                        reviewers?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        sourceRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                        targetRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; }; responses: { "200": { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create default reviewers condition
Description
Create a default reviewer pull request condition for the given repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; }
 Description
 The details needed to create a default reviewer pull request condition.
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The default reviewer pull request condition that was created.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition/{id}`

"/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: number; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    requiredApprovals?: number;
                    reviewers?: readonly {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<(...), (...)>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    }[];
                    sourceMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            name?: (...) | (...);
                        };
                    };
                    targetMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            name?: (...) | (...);
                        };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        requiredApprovals?: number;
                        reviewers?: readonly {
                            active?: boolean;
                            avatarUrl?: string;
                            displayName?: string;
                            emailAddress?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            slug?: string;
                            type?: "NORMAL" | "SERVICE";
                        }[];
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        sourceRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                        targetRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: number; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a default reviewer condition
Description
Delete the default reviewer pull request condition associated with the given ID.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: number; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: number; projectKey: string; repositorySlug: string }
 - Readonlyid: number
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the pull request condition was deleted
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 An empty response indicating a pull request condition with the given ID could not be found.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; }; responses: { "200": { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update a default reviewer condition
Description
Update the default reviewer pull request condition for the given ID.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: string; projectKey: string; repositorySlug: string }
 - Readonlyid: string
 Description
 The ID of the pull request condition
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: boolean; avatarUrl?: string; displayName?: string; emailAddress?: string; id?: number; links?: Record<(...), (...)>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated default reviewer pull request condition.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
Optional Readonlytrace?: undefined

`Readonly/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/conditions`

"/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/conditions": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": readonly {
                        id?: number;
                        requiredApprovals?: number;
                        reviewers?: readonly {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        }[];
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        sourceRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: { id?: ...; name?: ... };
                        };
                        targetRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: { id?: ...; name?: ... };
                        };
                    }[];
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": readonly { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; }[]; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get configured default reviewers
Description
Return a page of default reviewer pull request conditions that have been configured for this repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": readonly { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; }[]; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": readonly { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; }[]; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The default reviewer pull request conditions associated with the given repository.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/reviewers`

"/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/reviewers": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                sourceRefId?: string;
                sourceRepoId?: string;
                targetRefId?: string;
                targetRepoId?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": readonly {
                        id?: number;
                        requiredApprovals?: number;
                        reviewers?: readonly {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            slug?: (...) | (...);
                            type?: (...) | (...) | (...);
                        }[];
                        scope?: {
                            resourceId?: number;
                            type?: "GLOBAL"
                            | "PROJECT"
                            | "REPOSITORY";
                        };
                        sourceRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: { id?: ...; name?: ... };
                        };
                        targetRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: { id?: ...; name?: ... };
                        };
                    }[];
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { sourceRefId?: string; sourceRepoId?: string; targetRefId?: string; targetRepoId?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": readonly { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; }[]; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get required reviewers for PR creation
Description
Return a set of users who are required reviewers for pull requests created from the given source repository and ref to the given target ref in this repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { sourceRefId?: string; sourceRepoId?: string; targetRefId?: string; targetRepoId?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { sourceRefId?: string; sourceRepoId?: string; targetRefId?: string; targetRepoId?: string; }
 - Optional ReadonlysourceRefId?: string
 Description
 The ID of the source ref
 - Optional ReadonlysourceRepoId?: string
 Description
 The ID of the repository in which the source ref exists
 - Optional ReadonlytargetRefId?: string
 Description
 The ID of the target ref
 - Optional ReadonlytargetRepoId?: string
 Description
 The ID of the repository in which the target ref exists
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": readonly { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; }[]; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": readonly { id?: number; requiredApprovals?: number; reviewers?: readonly { active?: (...) | (...) | (...); avatarUrl?: (...) | (...); displayName?: (...) | (...); emailAddress?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); slug?: (...) | (...); type?: (...) | (...) | (...); }[]; scope?: { resourceId?: number; type?: "GLOBAL" | "PROJECT" | "REPOSITORY"; }; sourceRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; targetRefMatcher?: { displayId?: string; id?: string; type?: { id?: ...; name?: ... }; }; }[]; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The default reviewer pull request conditions associated with the given repository.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/default-tasks/latest/projects/{projectKey}/repos/{repositorySlug}/tasks`

"/default-tasks/latest/projects/{projectKey}/repos/{repositorySlug}/tasks": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { limit?: number; markup?: string; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly { description?: string; html?: string; id?: number }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    description?: string;
                    sourceMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: | "BRANCH"
                            | "ANY_REF"
                            | "MODEL_BRANCH"
                            | "MODEL_CATEGORY"
                            | "PATTERN";
                            name?: string;
                        };
                    };
                    targetMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: | "BRANCH"
                            | "ANY_REF"
                            | "MODEL_BRANCH"
                            | "MODEL_CATEGORY"
                            | "PATTERN";
                            name?: string;
                        };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        description?: string;
                        html?: string;
                        id?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Deletes all default tasks for the repository
Description
Delete all the default tasks for the supplied repository
The authenticated user must have **REPO_ADMIN** permission for this repository to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The default tasks have been deleted successfully.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete default tasks
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; markup?: string; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { description?: string; html?: string; id?: number }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a page of default tasks
Description
Retrieves the default tasks for the supplied repository.
The authenticated user must have **REPO_VIEW** permission for this repository to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; markup?: string; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; markup?: string; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlymarkup?: string
 Description
 If present or "true", includes a markup-rendered description
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { description?: string; html?: string; id?: number }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { description?: string; html?: string; id?: number }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of default tasks
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete default tasks
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody: { content: { "application/json": { description?: string; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }; responses: { "200": { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add a default task
Description
Creates a default task for the supplied repository.
The authenticated user must have **REPO_ADMIN** permission for this repository to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "application/json": { description?: string; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }
 Description
 The task to be added
- Readonlyresponses: { "200": { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The default task
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One or more of the following error cases occurred (check the error message for more details):
 - the description is empty- the sourceMatcher or targetMatcher is invalid
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to add a default task
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/default-tasks/latest/projects/{projectKey}/repos/{repositorySlug}/tasks/{taskId}`

"/default-tasks/latest/projects/{projectKey}/repos/{repositorySlug}/tasks/{taskId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string; taskId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string; taskId: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    description?: string;
                    sourceMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: | "BRANCH"
                            | "ANY_REF"
                            | "MODEL_BRANCH"
                            | "MODEL_CATEGORY"
                            | "PATTERN";
                            name?: string;
                        };
                    };
                    targetMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: | "BRANCH"
                            | "ANY_REF"
                            | "MODEL_BRANCH"
                            | "MODEL_CATEGORY"
                            | "PATTERN";
                            name?: string;
                        };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        description?: string;
                        html?: string;
                        id?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; taskId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a specific default task
Description
Delete a specific default task for a repository.
The authenticated user must have **REPO_ADMIN** permission for this repository to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; taskId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; taskId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlytaskId: string
 Description
 The ID of the default task
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The default task has been deleted successfully.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete default tasks
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or task does not exist
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; taskId: string }; query?: undefined; }; requestBody: { content: { "application/json": { description?: string; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }; responses: { "200": { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update a default task
Description
Updates a default task for the supplied repository.
The authenticated user must have **REPO_ADMIN** permission for this repository to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string; taskId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string; taskId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - ReadonlytaskId: string
 Description
 The ID of the default task
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "application/json": { description?: string; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }
 Description
 The task to be updated
- Readonlyresponses: { "200": { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The default task
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One or more of the following error cases occurred (check the error message for more details):
 - the provided taskId does not exist- the description is empty- the sourceMatcher or targetMatcher is invalid
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to add a default task
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Optional Readonlytrace?: undefined

`Readonly/default-tasks/latest/projects/{projectKey}/tasks`

"/default-tasks/latest/projects/{projectKey}/tasks": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: { limit?: number; markup?: string; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly { description?: string; html?: string; id?: number }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    description?: string;
                    sourceMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: | "BRANCH"
                            | "ANY_REF"
                            | "MODEL_BRANCH"
                            | "MODEL_CATEGORY"
                            | "PATTERN";
                            name?: string;
                        };
                    };
                    targetMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: | "BRANCH"
                            | "ANY_REF"
                            | "MODEL_BRANCH"
                            | "MODEL_CATEGORY"
                            | "PATTERN";
                            name?: string;
                        };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        description?: string;
                        html?: string;
                        id?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Deletes all default tasks for the project
Description
Delete all the default tasks for the supplied project
The authenticated user must have **PROJECT_ADMIN** permission for this project to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The default tasks have been deleted successfully.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete default tasks
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; markup?: string; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { description?: string; html?: string; id?: number }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a page of default tasks
Description
Retrieves the default tasks for the supplied project.
The authenticated user must have **PROJECT_VIEW** permission for this project to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; markup?: string; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: { limit?: number; markup?: string; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlymarkup?: string
 Description
 If present or "true", includes a markup-rendered description
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { description?: string; html?: string; id?: number }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { description?: string; html?: string; id?: number }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of default tasks
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete default tasks
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody: { content: { "application/json": { description?: string; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }; responses: { "200": { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add a default task
Description
Creates a default task for the project.
The authenticated user must have **PROJECT_ADMIN** permission for this project to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "application/json": { description?: string; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }
 Description
 The task to be added
- Readonlyresponses: { "200": { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The default task
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One or more of the following error cases occurred (check the error message for more details):
 - the description is empty- the sourceMatcher or targetMatcher is invalid
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to add a default task
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/default-tasks/latest/projects/{projectKey}/tasks/{taskId}`

"/default-tasks/latest/projects/{projectKey}/tasks/{taskId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; taskId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; taskId: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    description?: string;
                    sourceMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: | "BRANCH"
                            | "ANY_REF"
                            | "MODEL_BRANCH"
                            | "MODEL_CATEGORY"
                            | "PATTERN";
                            name?: string;
                        };
                    };
                    targetMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: | "BRANCH"
                            | "ANY_REF"
                            | "MODEL_BRANCH"
                            | "MODEL_CATEGORY"
                            | "PATTERN";
                            name?: string;
                        };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        description?: string;
                        html?: string;
                        id?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; taskId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a specific default task
Description
Delete a specific default task for a project.
The authenticated user must have **PROJECT_ADMIN** permission for this project to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; taskId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; taskId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlytaskId: string
 Description
 The ID of the default task
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The default task has been deleted successfully.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete default tasks
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project or task does not exist
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; taskId: string }; query?: undefined; }; requestBody: { content: { "application/json": { description?: string; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }; responses: { "200": { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update a default task
Description
Updates a default task for the supplied project.
The authenticated user must have **PROJECT_ADMIN** permission for this project to call the resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; taskId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; taskId: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlytaskId: string
 Description
 The ID of the default task
 - Optional Readonlyquery?: undefined
- ReadonlyrequestBody: { content: { "application/json": { description?: string; sourceMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; targetMatcher?: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }
 Description
 The task to be updated
- Readonlyresponses: { "200": { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { description?: string; html?: string; id?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The default task
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One or more of the following error cases occurred (check the error message for more details):
 - the provided taskId does not exist- the description is empty- the sourceMatcher or targetMatcher is invalid
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to add a default task
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist
Optional Readonlytrace?: undefined

`Readonly/git/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/rebase`

"/git/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/rebase": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        vetoes?: readonly {
                            detailedMessage?: string;
                            summaryMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: { content: { "application/json": { version?: number } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        refChange?: {
                            fromHash?: string;
                            ref?: {
                                displayId?: (...) | (...);
                                id?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            refId?: string;
                            toHash?: string;
                            type?: "DELETE"
                            | "ADD"
                            | "UPDATE";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { vetoes?: readonly { detailedMessage?: string; summaryMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Check PR rebase precondition
Description
Checks preconditions to determine whether the pull request can be rebased.
Some of the preconditions are: - The pull request is between Git repositories - The pull request is currently open - The pull request's PullRequest#getFromRef "from" ref is a branch - In other words, the qualified ID for the "from" ref must start with <code>refs/heads/</code> - Tags, and other non-standard refs, cannot be rebased - The current user has an e-mail address - Pull requests cannot be rebased anonymously - `git rebase` records the current user as the committer for the rebased commits, which requires a name and e-mail address - The current user has write access to the PullRequest#getFromRef "from" ref's repository - Note that in order to view a pull request a user is only required to have read access to the PullRequest#getToRef toRef's repository, so just because a user can see a pull request does not mean they can request a rebase This list is not exhaustive, and the exact set of preconditions applied can be extended by third-party add-ons. The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { vetoes?: readonly { detailedMessage?: string; summaryMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { vetoes?: readonly { detailedMessage?: string; summaryMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The rebaseability status of the pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the specified pull request.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { version?: number } } }; responses: { "200": { content: { "application/json": { refChange?: { fromHash?: string; ref?: { displayId?: (...) | (...); id?: (...) | (...); type?: (...) | (...) | (...); }; refId?: string; toHash?: string; type?: "DELETE" | "ADD" | "UPDATE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Rebase pull request
Description
Rebases the specified pull request, rewriting the incoming commits to start from the tip commit of the pull request's target branch. This operation alters the pull request's source branch and cannot be undone.
The authenticated user must have REPO_READ permission for the repository that this pull request targets and REPO_WRITE permission for the pull request's source repository to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlypullRequestId: string
 Description
 The ID of the pull request within the repository.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { version?: number } } }
 Description
 The pull request rebase request.
- Readonlyresponses: { "200": { content: { "application/json": { refChange?: { fromHash?: string; ref?: { displayId?: (...) | (...); id?: (...) | (...); type?: (...) | (...) | (...); }; refId?: string; toHash?: string; type?: "DELETE" | "ADD" | "UPDATE"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { refChange?: { fromHash?: string; ref?: { displayId?: (...) | (...); id?: (...) | (...); type?: (...) | (...) | (...); }; refId?: string; toHash?: string; type?: "DELETE" | "ADD" | "UPDATE"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The merged pull request.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the pull request and/or to update its source branch.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or pull request does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Any of the following error cases occurred (check the error message for more details):
 - The rebase encountered conflicts. - The rebase discarded all of the incoming commits and would have left the pull request empty - A <tt>PreRepositoryHook</tt> vetoed the rebase. - The specified version is out of date. - The specified pull request is not open. - The target repository is archived.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/git/latest/projects/{projectKey}/repos/{repositorySlug}/tags`

"/git/latest/projects/{projectKey}/repos/{repositorySlug}/tags": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    force?: boolean;
                    message?: string;
                    name?: string;
                    startPoint?: string;
                    type?: "ANNOTATED"
                    | "LIGHTWEIGHT";
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        displayId?: string;
                        hash?: string;
                        id?: string;
                        latestChangeset?: string;
                        latestCommit?: string;
                        type?: "BRANCH"
                        | "TAG";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { force?: boolean; message?: string; name?: string; startPoint?: string; type?: "ANNOTATED" | "LIGHTWEIGHT"; }; }; }; responses: { "201": { content: { "application/json": { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create tag
Description
Creates a tag in the specified repository.
The authenticated user must have an effective REPO_WRITE permission to call this resource. 'LIGHTWEIGHT' and 'ANNOTATED' are the two type of tags that can be created. The 'startPoint' can either be a ref or a 'commit'.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { force?: boolean; message?: string; name?: string; startPoint?: string; type?: "ANNOTATED" | "LIGHTWEIGHT"; }; }; }
 Description
 The create git tag request.
- Readonlyresponses: { "201": { content: { "application/json": { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { displayId?: string; hash?: string; id?: string; latestChangeset?: string; latestCommit?: string; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A JSON representation of the newly created tag.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The tag was not created because the request was invalid, e.g. the provided ref name already existed in the repository, or was not a valid ref name in the repository, or the start point is invalid.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create a tag. This could be due to insufficient repository permissions.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/git/latest/projects/{projectKey}/repos/{repositorySlug}/tags/{name}`

"/git/latest/projects/{projectKey}/repos/{repositorySlug}/tags/{name}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { name: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { name: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete tag
Description
Deletes a tag in the specified repository.
The authenticated user must have an effective REPO_WRITE permission to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { name: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { name: string; projectKey: string; repositorySlug: string }
 - Readonlyname: string
 Description
 The name of the tag to be deleted.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the tag no longer exists in the repository.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The tag was not deleted because repository is either empty, or is not a git repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete a tag. This could be due to insufficient repository permissions.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 If the tag doesn't exist in the repository.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/gpg/latest/keys`

"/gpg/latest/keys": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { user?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { limit?: number; start?: number; user?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            emailAddress?: string;
                            expiryDate?: number;
                            fingerprint?: string;
                            id?: string;
                            subKeys?: readonly (...)[];
                            text?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { user?: string };
        };
        requestBody?: {
            content: {
                "application/json": {
                    emailAddress?: string;
                    expiryDate?: number;
                    fingerprint?: string;
                    id?: string;
                    subKeys?: readonly { expiryDate?: string; fingerprint?: string }[];
                    text?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        emailAddress?: string;
                        expiryDate?: number;
                        fingerprint?: string;
                        id?: string;
                        subKeys?: readonly { expiryDate?: string; fingerprint?: string }[];
                        text?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { user?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete all GPG keys for user
Description
Delete all GPG keys for a supplied user.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { user?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { user?: string }
 - Optional Readonlyuser?: string
 Description
 The username of the user to delete the keys for. If no username is specified, the GPG keys will be deleted for the currently authenticated user.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The GPG keys matching the supplied user were deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the GPG keys. This is only possible when a user is explicitly supplied.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No user matches the supplied user.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number; user?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { emailAddress?: string; expiryDate?: number; fingerprint?: string; id?: string; subKeys?: readonly (...)[]; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all GPG keys
Description
Find all the keys for the currently authenticated user. Optionally, users with ADMIN and higher permissions may choose to specify the user parameter to retrieve GPG keys for another user.
Only authenticated users may call this endpoint.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number; user?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; start?: number; user?: string }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlyuser?: string
 Description
 The name of the user to get keys for (optional; requires ADMIN permission or higher).
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { emailAddress?: string; expiryDate?: number; fingerprint?: string; id?: string; subKeys?: readonly (...)[]; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { emailAddress?: string; expiryDate?: number; fingerprint?: string; id?: string; subKeys?: readonly (...)[]; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Returns a paged response of of keys for the user.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to perform this operation.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { user?: string }; }; requestBody?: { content: { "application/json": { emailAddress?: string; expiryDate?: number; fingerprint?: string; id?: string; subKeys?: readonly { expiryDate?: string; fingerprint?: string }[]; text?: string; }; }; }; responses: { "200": { content: { "application/json": { emailAddress?: string; expiryDate?: number; fingerprint?: string; id?: string; subKeys?: readonly { expiryDate?: string; fingerprint?: string }[]; text?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create a GPG key
Description
Add a GPG key to the authenticated user's account. Optionally, users with ADMIN and higher permissions may choose to specify the user parameter to add a GPG key for another user.
Only authenticated users may call this endpoint.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { user?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { user?: string }
 - Optional Readonlyuser?: string
 Description
 The name of the user to add a key for (optional; requires ADMIN permission or higher).
- Optional ReadonlyrequestBody?: { content: { "application/json": { emailAddress?: string; expiryDate?: number; fingerprint?: string; id?: string; subKeys?: readonly { expiryDate?: string; fingerprint?: string }[]; text?: string; }; }; }
 Description
 The request body.
- Readonlyresponses: { "200": { content: { "application/json": { emailAddress?: string; expiryDate?: number; fingerprint?: string; id?: string; subKeys?: readonly { expiryDate?: string; fingerprint?: string }[]; text?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { emailAddress?: string; expiryDate?: number; fingerprint?: string; id?: string; subKeys?: readonly { expiryDate?: string; fingerprint?: string }[]; text?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Response contains the GPG key that was just created.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request has failed validation.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to perform this operation.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/gpg/latest/keys/{fingerprintOrId}`

"/gpg/latest/keys/{fingerprintOrId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { fingerprintOrId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { fingerprintOrId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a GPG key
Description
Delete the GPG key with the specified ID or Key Fingerprint.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { fingerprintOrId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { fingerprintOrId: string }
 - ReadonlyfingerprintOrId: string
 Description
 The GPG fingerprint or ID.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The key has been deleted successfully.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to perform this operation.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/annotations`

"/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/annotations": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: {
                externalId?: string;
                key?: string;
                path?: string;
                severity?: string;
                type?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        annotations?: readonly {
                            externalId?: string;
                            line?: number;
                            link?: string;
                            message?: string;
                            path?: string;
                            reportKey?: string;
                            severity?: string;
                            type?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { externalId?: string; key?: string; path?: string; severity?: string; type?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { annotations?: readonly { externalId?: string; line?: number; link?: string; message?: string; path?: string; reportKey?: string; severity?: string; type?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get Code Insights annotations for a commit
Description
Get annotations for the given commit ID, filtered by any query parameters given.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { externalId?: string; key?: string; path?: string; severity?: string; type?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit ID on which to record the annotation. This must be a full 40 character commit hash.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { externalId?: string; key?: string; path?: string; severity?: string; type?: string; }
 - Optional ReadonlyexternalId?: string
 Description
 Return only annotations that have one of the provided external IDs. Can be specified more than once to filter by more than one external ID.
 - Optional Readonlykey?: string
 Description
 Return only annotations that belong to one of the provided report keys. Can be specified more than once to filter by more than one report
 - Optional Readonlypath?: string
 Description
 Return only annotations that appear on one of the provided paths. Can be specified more than once to filter by more than one path.
 - Optional Readonlyseverity?: string
 Description
 Return only annotations that have one of the given severities. Can be specified more than once to filter by more than one severity. Valid severities are LOW, MEDIUM and HIGH.
 - Optional Readonlytype?: string
 Description
 Return only annotations that have one of the given types. Can be specified more than once to filter by multiple types. Valid types are BUG, CODE_SMELL, and VULNERABILITY.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { annotations?: readonly { externalId?: string; line?: number; link?: string; message?: string; path?: string; reportKey?: string; severity?: string; type?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { annotations?: readonly { externalId?: string; line?: number; link?: string; message?: string; path?: string; reportKey?: string; severity?: string; type?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested annotations.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions (REPO_READ) to get insight annotations.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository, commit, or report does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports`

"/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commitId: string; projectKey: string; repositorySlug: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            createdDate?: number;
                            data?: readonly (...)[];
                            details?: string;
                            key?: string;
                            link?: string;
                            logoUrl?: string;
                            reporter?: string;
                            result?: "FAIL" | "PASS";
                            title?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: number; data?: readonly (...)[]; details?: string; key?: string; link?: string; logoUrl?: string; reporter?: string; result?: "FAIL" | "PASS"; title?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all Code Insights reports for a commit
Description
Retrieve all reports for the given commit.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit ID on which to record the annotation. This must be a full 40 character commit hash.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: number; data?: readonly (...)[]; details?: string; key?: string; link?: string; logoUrl?: string; reporter?: string; result?: "FAIL" | "PASS"; title?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: number; data?: readonly (...)[]; details?: string; key?: string; link?: string; logoUrl?: string; reporter?: string; result?: "FAIL" | "PASS"; title?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of reports
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions (REPO_READ) to get insight reports.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository or commit does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}`

"/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commitId: string;
                key: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commitId: string;
                key: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdDate?: number;
                        data?: readonly {
                            title?: string;
                            type?: string;
                            value?: Record<(...), (...)>;
                        }[];
                        details?: string;
                        key?: string;
                        link?: string;
                        logoUrl?: string;
                        reporter?: string;
                        result?: "FAIL"
                        | "PASS";
                        title?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commitId: string;
                key: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    coverageProviderKey?: string;
                    createdDate?: number;
                    data: readonly {
                        title?: string;
                        type?: string;
                        value?: Record<string, unknown>;
                    }[];
                    details?: string;
                    link?: string;
                    logoUrl?: string;
                    reporter?: string;
                    result?: string;
                    title: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdDate?: number;
                        data?: readonly {
                            title?: string;
                            type?: string;
                            value?: Record<(...), (...)>;
                        }[];
                        details?: string;
                        key?: string;
                        link?: string;
                        logoUrl?: string;
                        reporter?: string;
                        result?: "FAIL"
                        | "PASS";
                        title?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a Code Insights report
Description
Delete a report for the given commit. Also deletes any annotations associated with this report.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; key: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit ID on which to record the annotation. This must be a full 40 character commit hash.
 - Readonlykey: string
 Description
 The key of the report to which this annotation belongs.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The report and associated annotations were successfully deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete insight reports or was not the author (REPO_READ for author otherwise REPO_ADMIN).
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository, commit or report does not exist.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { createdDate?: number; data?: readonly { title?: string; type?: string; value?: Record<(...), (...)>; }[]; details?: string; key?: string; link?: string; logoUrl?: string; reporter?: string; result?: "FAIL" | "PASS"; title?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a Code Insights report
Description
Retrieve the specified report.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; key: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit ID on which to record the annotation. This must be a full 40 character commit hash.
 - Readonlykey: string
 Description
 The report key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { createdDate?: number; data?: readonly { title?: string; type?: string; value?: Record<(...), (...)>; }[]; details?: string; key?: string; link?: string; logoUrl?: string; reporter?: string; result?: "FAIL" | "PASS"; title?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { createdDate?: number; data?: readonly { title?: string; type?: string; value?: Record<(...), (...)>; }[]; details?: string; key?: string; link?: string; logoUrl?: string; reporter?: string; result?: "FAIL" | "PASS"; title?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified report.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions (REPO_READ needed) to get insight reports.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository, commit, or report does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined

Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { coverageProviderKey?: string; createdDate?: number; data: readonly { title?: string; type?: string; value?: Record<string, unknown>; }[]; details?: string; link?: string; logoUrl?: string; reporter?: string; result?: string; title: string; }; }; }; responses: { "200": { content: { "application/json": { createdDate?: number; data?: readonly { title?: string; type?: string; value?: Record<(...), (...)>; }[]; details?: string; key?: string; link?: string; logoUrl?: string; reporter?: string; result?: "FAIL" | "PASS"; title?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }

Create a Code Insights report

`Description`

Create a new insight report, or replace the existing one if a report already exists for the given repository, commit, and report key. A request to replace an existing report will be rejected if the authenticated user was not the creator of the specified report.


The report key should be a unique string chosen by the reporter and should be unique enough not to potentially clash with report keys from other reporters. We recommend using reverse DNS namespacing or a similar standard to ensure that collision is avoided.<h1>Report parameters</h1><table summary="Report parameters">    <tr>        <th>Parameter</th>        <th>Description</th>        <th>Required?</th>        <th>Restrictions</th>        <th>Type</th>    </tr>    <tr>        <td>title</td>        <td>A short string representing the name of the report</td>        <td>Yes</td>        <td>Max length: 450 characters (but we recommend that it is shorter so that the display is nicer)</td>        <td>String</td>    </tr>    <tr>        <td>details</td>        <td>             A string to describe the purpose of the report. This string may contain             escaped newlines and if it does it will display the content accordingly.        </td>        <td>No</td>        <td>Max length: 2000 characters</td>        <td>String</td>    </tr>    <tr>        <td>result</td>        <td>Indicates whether the report is in a passed or failed state</td>        <td>No</td>        <td>One of: PASS, FAIL</td>        <td>String</td>    </tr>    <tr>        <td>data</td>        <td>An array of data fields (described below) to display information on the report</td>        <td>No</td>        <td>Maximum 6 data fields</td>        <td>Array</td>    </tr>    <tr>        <td>reporter</td>        <td>A string to describe the tool or company who created the report</td>        <td>No</td>        <td>Max length: 450 characters</td>        <td>String</td>    </tr>    <tr>        <td>link</td>        <td>A URL linking to the results of the report in an external tool.</td>        <td>No</td>        <td>Must be a valid http or https URL</td>        <td>String</td>    </tr>    <tr>        <td>logoUrl</td>        <td>A URL to the report logo. If none is provided, the default insights logo will be used.</td>        <td>No</td>        <td>Must be a valid http or https URL</td>        <td>String</td>    </tr></table><h1>Data parameters</h1>The data field on the report is an array with at most 6 data fields (JSON maps) containing information that is to be displayed on the report (see the request example).<table summary="Data parameters">    <tr>        <th>Parameter</th>        <th>Description</th>        <th>Type</th>    </tr>    <tr>        <td>title</td>        <td>A string describing what this data field represents</td>        <td>String</td>    </tr>    <tr>        <td>type</td>        <td>             The type of data contained in the value field. If not provided,             then the value will be detected as a boolean, number or string.             One of: BOOLEAN, DATE, DURATION, LINK, NUMBER, PERCENTAGE, TEXT        </td>        <td>String</td>    </tr>    <tr>        <td>value</td>        <td>            A value based on the type provided. Either a raw value             (string, number or boolean) or a map. See below.        </td>    </tr></table><table summary="Types">    <tr>        <th>Type Field</th>        <th>Value Field Type</th>        <th>Value Field Display</th>    </tr>    <tr>        <td>None/Omitted</td>        <td>Number, String or Boolean (not an array or object)</td>        <td>Plain text</td>    </tr>    <tr>        <td>BOOLEAN</td>        <td>Boolean</td>        <td>The value will be read as a JSON boolean and displayed as 'Yes' or 'No'.</td>    </tr>    <tr>        <td>DATE</td>        <td>Number</td>        <td>             The value will be read as a JSON number in the form of a Unix timestamp              (milliseconds) and will be displayed as a relative date if the date is less             than one week ago, otherwise it will be displayed as an absolute date.        </td>    </tr>    <tr>        <td>DURATION</td>        <td>Number</td>        <td>             The value will be read as a JSON number in milliseconds and             will be displayed in a human readable duration format.        </td>    </tr>    <tr>        <td>LINK</td>        <td>Object: {"linktext": "Link text here", "href": "https://link.to.annotation/in/external/tool"}</td>        <td>             The value will be read as a JSON object containing the fields "linktext"             and "href" and will be displayed as a clickable link on the report.        </td>    </tr>    <tr>        <td>NUMBER</td>        <td>Number</td>        <td>             The value will be read as a JSON number and large numbers will             be displayed in a human readable format (e.g. 14.3k).        </td>    </tr>    <tr>        <td>PERCENTAGE</td>        <td>Number (between 0 and 100)</td>        <td>             The value will be read as a JSON number between 0 and 100              and will be displayed with a percentage sign.        </td>    </tr>    <tr>        <td>TEXT</td>        <td>String</td>        <td>The value will be read as a JSON string and will be displayed as-is</td>    </tr></table>

Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
- Optional Readonlycookie?: undefined
- Optional Readonlyheader?: undefined
- Readonlypath: { commitId: string; key: string; projectKey: string; repositorySlug: string }
  - ReadonlycommitId: string
    Description
    The commit ID on which to record the annotation. This must be a full 40 character commit hash.
  - Readonlykey: string
    Description
    A unique string representing the report as chosen by the reporter. This should be unique enough to not clash with other report's keys. To do this, we recommend namespacing the key using reverse DNS
  - ReadonlyprojectKey: string
    Description
    The project key.
  - ReadonlyrepositorySlug: string
    Description
    The repository slug.
- Optional Readonlyquery?: undefined
Optional ReadonlyrequestBody?: { content: { "application/json": { coverageProviderKey?: string; createdDate?: number; data: readonly { title?: string; type?: string; value?: Record<string, unknown>; }[]; details?: string; link?: string; logoUrl?: string; reporter?: string; result?: string; title: string; }; }; }
Description
The request object containing the details of the report to create (see example).
Readonlyresponses: { "200": { content: { "application/json": { createdDate?: number; data?: readonly { title?: string; type?: string; value?: Record<(...), (...)>; }[]; details?: string; key?: string; link?: string; logoUrl?: string; reporter?: string; result?: "FAIL" | "PASS"; title?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
- Readonly200: { content: { "application/json": { createdDate?: number; data?: readonly { title?: string; type?: string; value?: Record<(...), (...)>; }[]; details?: string; key?: string; link?: string; logoUrl?: string; reporter?: string; result?: "FAIL" | "PASS"; title?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The created report.
- Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 One of the following error cases occurred (check the error message for more details):
 - The request does not contain a report title. - The data field contains unsupported objects. - The request does not contain a report key/ - The provided commit hash is invalid, according to the validation rules mentioned for the commitId above.
- Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not permitted to create an insight report or authentication failed.

Optional Readonlytrace?: undefined

`Readonly/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}/annotations`

"/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}/annotations": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commitId: string;
                key: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: { externalId?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commitId: string;
                key: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        annotations?: readonly {
                            externalId?: string;
                            line?: number;
                            link?: string;
                            message?: string;
                            path?: string;
                            reportKey?: string;
                            severity?: string;
                            type?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commitId: string;
                key: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    annotations?: readonly {
                        externalId?: string;
                        line?: number;
                        link?: string;
                        message: string;
                        path?: string;
                        severity: string;
                        type?: string;
                    }[];
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: { externalId?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete Code Insights annotations
Description
Delete annotations for a given report that match the given external IDs, or all annotations if no external IDs are provided.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: { externalId?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; key: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit ID on which to record the annotation. This must be a full 40 character commit hash.
 - Readonlykey: string
 Description
 The key of the report to which this annotation belongs.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { externalId?: string }
 - Optional ReadonlyexternalId?: string
 Description
 The external IDs for the annotations that are to be deleted. Can be specified more than once to delete by more than one external ID, or can be unspecified to delete all annotations.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The annotations were successfully deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete insight reports or was not the author (REPO_READ for author otherwise REPO_ADMIN).
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository, commit or report does not exist.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { annotations?: readonly { externalId?: string; line?: number; link?: string; message?: string; path?: string; reportKey?: string; severity?: string; type?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get Code Insights annotations for a report
Description
Retrieve the specified report's annotations.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; key: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit ID on which to record the annotation. This must be a full 40 character commit hash.
 - Readonlykey: string
 Description
 The report key.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { annotations?: readonly { externalId?: string; line?: number; link?: string; message?: string; path?: string; reportKey?: string; severity?: string; type?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { annotations?: readonly { externalId?: string; line?: number; link?: string; message?: string; path?: string; reportKey?: string; severity?: string; type?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified annotations.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions (REPO_READ needed) to get insight reports.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository, commit, or report does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { annotations?: readonly { externalId?: string; line?: number; link?: string; message: string; path?: string; severity: string; type?: string; }[]; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add Code Insights annotations
Description
Add annotations to the given report. The request should be a JSON object mapping the string "annotations" to an array of maps containing the annotation data, as described below. See also the example request.
A few things to note:- Annotations are an extension of a report, so a report must first exist in order to post annotations. Annotations are posted separately from the report, and can be posted in bulk using this endpoint. - Only the annotations that are on lines changed in the unified diff will be displayed. This means it is likely not all annotations posted will be displayed on the pull request It also means that if the user is viewing a side-by-side diff, commit diff or iterative review diff they will not be able to view the annotations. - A report cannot have more than 1000 annotations by default, however this property is congurable at an instance level. If the request would result in more than the maximum number of annotations being stored then the entire request is rejected and no new annotations are stored. - There is no de-duplication of annotations on Bitbucket so be sure that reruns of builds will first delete the report and annotations before creating them. # Annotation parameters |Parameter|Description|Required?|Restrictions|Type| |--- |--- |--- |--- |--- | |path|The path of the file on which this annotation should be placed. This is the path of the filerelative to the git repository. If no path is provided, then it will appear in the overview modalon all pull requests where the tip of the branch is the given commit, regardless of which files weremodified.|No||String| |line|The line number that the annotation should belong to. If no line number is provided, then it willdefault to 0 and in a pull request it will appear at the top of the file specified by the path field.|No|Non-negative integer|Integer| |message|The message to display to users|Yes|The maximum length accepted is 2000 characters, however the user interface may truncate this valuefor display purposes. We recommend that the message is short and succinct, with further detailsavailable to the user if needed on the page linked to by the the annotation link.|String| |severity|The severity of the annotation|Yes|One of: LOW, MEDIUM, HIGH|String| |link|An http or https URL representing the location of the annotation in the external tool|No||String| |type|The type of annotation posted|No|One of: VULNERABILITY, CODE_SMELL, BUG|String| |externalId|If the caller requires a link to get or modify this annotation, then an ID must be provided. It isnot used or required by Bitbucket, but only by the annotation creator for updating or deleting thisspecific annotation.|No|A string value shorter than 450 characters|String|
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; key: string; projectKey: string; repositorySlug: string }
 - ReadonlycommitId: string
 Description
 The commit ID on which to record the annotation. This must be a full 40 character commit hash.
 - Readonlykey: string
 Description
 The key of the report to which this annotation belongs.
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { annotations?: readonly { externalId?: string; line?: number; link?: string; message: string; path?: string; severity: string; type?: string; }[]; }; }; }
 Description
 The annotations to add.
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating that the request succeeded.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not the author of the report, or the author no longer has sufficient permissions (REPO_READ).
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository, commit, or report does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}/annotations/{externalId}`

"/insights/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}/annotations/{externalId}": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                commitId: string;
                externalId: string;
                key: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    externalId?: string;
                    line?: number;
                    link?: string;
                    message: string;
                    path?: string;
                    severity: string;
                    type?: string;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { commitId: string; externalId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: { content: { "application/json": { externalId?: string; line?: number; link?: string; message: string; path?: string; severity: string; type?: string; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create or replace a Code Insights annotation
Description
Create an annotation with the given external ID, or replace it if it already exists. A request to replace an existing annotation will be rejected if the authenticated user was not the creator of the specified report.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commitId: string; externalId: string; key: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commitId: string; externalId: string; key: string; projectKey: string; repositorySlug: string; }
 - ReadonlycommitId: string
 Description
 The commit ID on which to record the annotation. This must be a full 40 character commit hash.
 - ReadonlyexternalId: string
 Description
 The external ID of the annotation that is to be updated or created
 - Readonlykey: string
 Description
 The key of the report to which this annotation belongs
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { externalId?: string; line?: number; link?: string; message: string; path?: string; severity: string; type?: string; }; }; }
 Description
 The new annotation that is to replace the existing one.
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 No content, indicating that the request succeeded.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not the author of the report, or the author no longer has sufficient permissions (REPO_READ).
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project, repository, commit, report or annotation does not exist.
Optional Readonlytrace?: undefined

`Readonly/jira/latest/comments/{commentId}/issues`

"/jira/latest/comments/{commentId}/issues": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { commentId: string };
            query?: { applicationId?: string };
        };
        requestBody?: { content: { "application/json": string } };
        responses: {
            "200": {
                content: {
                    "application/json": { commentId?: number; issueKey?: string };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { commentId: string }; query?: { applicationId?: string }; }; requestBody?: { content: { "application/json": string } }; responses: { "200": { content: { "application/json": { commentId?: number; issueKey?: string }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create Jira Issue
Description
Create a Jira issue and associate it with a comment on a pull request.
This resource can only be used with comments on a pull request. Attempting to call this resource with a different type of comment (for example, a comment on a commit) will result in an error. The authenticated user must have REPO_READ permission for the repository containing the comment to call this resource. The JSON structure for the create issue format is specified by Jira's REST v2 API.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { commentId: string }; query?: { applicationId?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { commentId: string }
 - ReadonlycommentId: string
 Description
 the comment to associate the created Jira issue to
 - Optional Readonlyquery?: { applicationId?: string }
 - Optional ReadonlyapplicationId?: string
 Description
 id of the Jira server
- Optional ReadonlyrequestBody?: { content: { "application/json": string } }
 Description
 A String representation of the JSON format Jira create issue request see: Jira REST API
- Readonlyresponses: { "200": { content: { "application/json": { commentId?: number; issueKey?: string }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { commentId?: number; issueKey?: string }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The created Jira issue key and the associated comment ID
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified application link ID does not match any linked Jira instance.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Authentication with the Jira instance is required.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/jira/latest/issues/{issueKey}/commits`

"/jira/latest/issues/{issueKey}/commits": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { issueKey: string };
            query?: { limit?: number; maxChanges?: string; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            changes?: {
                                isLastPage?: ...;
                                limit?: ...;
                                nextPageStart?: ...;
                                size?: ...;
                                start?: ...;
                                values?: ...;
                            };
                            fromCommit?: { displayId?: ...; id?: ... };
                            links?: Record<(...), (...)>;
                            repository?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                origin?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            toCommit?: {
                                author?: ...;
                                authorTimestamp?: ...;
                                committer?: ...;
                                committerTimestamp?: ...;
                                displayId?: ...;
                                id?: ...;
                                message?: ...;
                                parents?: ...;
                            };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { issueKey: string }; query?: { limit?: number; maxChanges?: string; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { changes?: { isLastPage?: ...; limit?: ...; nextPageStart?: ...; size?: ...; start?: ...; values?: ...; }; fromCommit?: { displayId?: ...; id?: ... }; links?: Record<(...), (...)>; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; toCommit?: { author?: ...; authorTimestamp?: ...; committer?: ...; committerTimestamp?: ...; displayId?: ...; id?: ...; message?: ...; parents?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get changesets for issue key
Description
Retrieve a page of changesets associated with the given issue key.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { issueKey: string }; query?: { limit?: number; maxChanges?: string; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { issueKey: string }
 - ReadonlyissueKey: string
 Description
 The issue key to search by
 - Optional Readonlyquery?: { limit?: number; maxChanges?: string; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional ReadonlymaxChanges?: string
 Description
 The maximum number of changes to retrieve for each changeset
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { changes?: { isLastPage?: ...; limit?: ...; nextPageStart?: ...; size?: ...; start?: ...; values?: ...; }; fromCommit?: { displayId?: ...; id?: ... }; links?: Record<(...), (...)>; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; toCommit?: { author?: ...; authorTimestamp?: ...; committer?: ...; committerTimestamp?: ...; displayId?: ...; id?: ...; message?: ...; parents?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { changes?: { isLastPage?: ...; limit?: ...; nextPageStart?: ...; size?: ...; start?: ...; values?: ...; }; fromCommit?: { displayId?: ...; id?: ... }; links?: Record<(...), (...)>; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; toCommit?: { author?: ...; authorTimestamp?: ...; committer?: ...; committerTimestamp?: ...; displayId?: ...; id?: ...; message?: ...; parents?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of detailed changesets
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/jira/latest/projects/{projectKey}/primary-enhanced-entitylink`

"/jira/latest/projects/{projectKey}/primary-enhanced-entitylink": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        applicationLinkId?: string;
                        displayUrl?: string;
                        projectId?: number;
                        projectKey?: string;
                        projectName?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { applicationLinkId?: string; displayUrl?: string; projectId?: number; projectKey?: string; projectName?: string; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get entity link
Description
Retrieves the enchanced primary entitylink
The authenticated user must have PROJECT_READ permission for the project having the primary enhanced entitylink.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { applicationLinkId?: string; displayUrl?: string; projectId?: number; projectKey?: string; projectName?: string; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { applicationLinkId?: string; displayUrl?: string; projectId?: number; projectKey?: string; projectName?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The primary enhanced entitylink.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/jira/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/issues`

"/jira/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/issues": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                projectKey: string;
                pullRequestId: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json;charset=UTF-8": readonly {
                        key?: string;
                        url?: string;
                    }[];
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json;charset=UTF-8": readonly { key?: string; url?: string; }[]; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get issues for a pull request
Description
Retrieves Jira issue keys that are associated with the commits in the specified pull request. The number of commits checked for issues is limited to a default of 100.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; pullRequestId: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; pullRequestId: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlypullRequestId: string
 Description
 The pull request id
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json;charset=UTF-8": readonly { key?: string; url?: string; }[]; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json;charset=UTF-8": readonly { key?: string; url?: string; }[]; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A list of Jira issues keys for the pull request
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh`

"/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: {
                effective?: string;
                filter?: string;
                limit?: number;
                minimumPermission?: string;
                permission?: string;
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            key?: {
                                algorithmType?: ...;
                                bitLength?: ...;
                                createdDate?: ...;
                                expiryDays?: ...;
                                fingerprint?: ...;
                                id?: ...;
                                label?: ...;
                                lastAuthenticated?: ...;
                                text?: ...;
                            };
                            permission?: | "ADMIN"
                            | "LICENSED_USER"
                            | "PROJECT_ADMIN"
                            | "PROJECT_CREATE"
                            | "PROJECT_READ"
                            | "PROJECT_VIEW"
                            | "PROJECT_WRITE"
                            | "REPO_ADMIN"
                            | "REPO_CREATE"
                            | "REPO_READ"
                            | "REPO_WRITE"
                            | "SYS_ADMIN"
                            | "USER_ADMIN";
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            repository?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                origin?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    key?: {
                        algorithmType?: string;
                        bitLength?: number;
                        createdDate?: string;
                        expiryDays?: number;
                        fingerprint?: string;
                        id?: number;
                        label?: string;
                        lastAuthenticated?: string;
                        text?: string;
                    };
                    permission?: | "ADMIN"
                    | "LICENSED_USER"
                    | "PROJECT_ADMIN"
                    | "PROJECT_CREATE"
                    | "PROJECT_READ"
                    | "PROJECT_VIEW"
                    | "PROJECT_WRITE"
                    | "REPO_ADMIN"
                    | "REPO_CREATE"
                    | "REPO_READ"
                    | "REPO_WRITE"
                    | "SYS_ADMIN"
                    | "USER_ADMIN";
                    project?: {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                    repository?: {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        origin?: {
                            archived?: (...) | (...) | (...);
                            defaultBranch?: (...) | (...);
                            description?: (...) | (...);
                            forkable?: (...) | (...) | (...);
                            hierarchyId?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            partition?: (...) | (...);
                            project?: (...) | (...);
                            public?: (...) | (...) | (...);
                            relatedLinks?: (...) | (...);
                            scmId?: (...) | (...);
                            scope?: (...) | (...);
                            slug?: (...) | (...);
                            state?: (...) | (...) | (...) | (...) | (...);
                            statusMessage?: (...) | (...);
                        };
                        partition?: number;
                        project?: {
                            avatar?: (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            description?: (...) | (...);
                            id?: (...) | (...);
                            key: string;
                            links?: (...) | (...);
                            name?: (...) | (...);
                            public?: (...) | (...) | (...);
                            scope?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        key?: {
                            algorithmType?: string;
                            bitLength?: number;
                            createdDate?: string;
                            expiryDays?: number;
                            fingerprint?: string;
                            id?: number;
                            label?: string;
                            lastAuthenticated?: string;
                            text?: string;
                        };
                        permission?: | "ADMIN"
                        | "LICENSED_USER"
                        | "PROJECT_ADMIN"
                        | "PROJECT_CREATE"
                        | "PROJECT_READ"
                        | "PROJECT_VIEW"
                        | "PROJECT_WRITE"
                        | "REPO_ADMIN"
                        | "REPO_CREATE"
                        | "REPO_READ"
                        | "REPO_WRITE"
                        | "SYS_ADMIN"
                        | "USER_ADMIN";
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        repository?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            origin?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            partition?: number;
                            project?: {
                                avatar?: (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { effective?: string; filter?: string; limit?: number; minimumPermission?: string; permission?: string; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository SSH keys
Description
Retrieves the access keys for the repository identified in the URL.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { effective?: string; filter?: string; limit?: number; minimumPermission?: string; permission?: string; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { effective?: string; filter?: string; limit?: number; minimumPermission?: string; permission?: string; start?: number; }
 - Optional Readonlyeffective?: string
 Description
 Controls whether SSH access keys configured at the project level should be included in the results or not. When set to true all keys that have access to the repository (including project level keys) are included in the results. When set to false, only access keys configured for the specified repository are considered. Default is false.
 - Optional Readonlyfilter?: string
 Description
 If specified only SSH access keys with a label prefixed with the supplied string will be returned
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional ReadonlyminimumPermission?: string
 Description
 If specified only SSH access keys with at least the supplied permission will be returned. Default is Permission.REPO_READ.
 - Optional Readonlypermission?: string
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A single page of access keys for the repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the access keys for this repository
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; }; responses: { "201": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add repository SSH key
Description
Register a new SSH key and grants access to the repository identified in the URL.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; }
- Readonlyresponses: { "201": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created access key.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The current request contains invalid or missing values.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to add an access key to the repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh/{keyId}`

"/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh/{keyId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { keyId: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { keyId: string; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        key?: {
                            algorithmType?: string;
                            bitLength?: number;
                            createdDate?: string;
                            expiryDays?: number;
                            fingerprint?: string;
                            id?: number;
                            label?: string;
                            lastAuthenticated?: string;
                            text?: string;
                        };
                        permission?: | "ADMIN"
                        | "LICENSED_USER"
                        | "PROJECT_ADMIN"
                        | "PROJECT_CREATE"
                        | "PROJECT_READ"
                        | "PROJECT_VIEW"
                        | "PROJECT_WRITE"
                        | "REPO_ADMIN"
                        | "REPO_CREATE"
                        | "REPO_READ"
                        | "REPO_WRITE"
                        | "SYS_ADMIN"
                        | "USER_ADMIN";
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        repository?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            origin?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            partition?: number;
                            project?: {
                                avatar?: (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Revoke repository SSH key
Description
Remove an existing access key for the repository identified in the URL. If the same SSH key is used as an access key for multiple projects or repositories, only the access to the repository identified in the URL will be revoked.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { keyId: string; projectKey: string; repositorySlug: string }
 - ReadonlykeyId: string
 Description
 The key id
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The access key was deleted (or none was found matching the given id).
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to remove access keys for this repository
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: string; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository SSH key
Description
Retrieves the access key for the SSH key with id keyId on the repository identified in the URL.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: string; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { keyId: string; projectKey: string; repositorySlug: string }
 - ReadonlykeyId: string
 Description
 The key id
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The access key for the repository and SSH key with ID keyId.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the access keys for this repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or key does not exist or the key does not have access on the repository.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh/{keyId}/permission/{permission}`

"/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh/{keyId}/permission/{permission}": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: {
                keyId: string;
                permission: string;
                projectKey: string;
                repositorySlug: string;
            };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        key?: {
                            algorithmType?: string;
                            bitLength?: number;
                            createdDate?: string;
                            expiryDays?: number;
                            fingerprint?: string;
                            id?: number;
                            label?: string;
                            lastAuthenticated?: string;
                            text?: string;
                        };
                        permission?: | "ADMIN"
                        | "LICENSED_USER"
                        | "PROJECT_ADMIN"
                        | "PROJECT_CREATE"
                        | "PROJECT_READ"
                        | "PROJECT_VIEW"
                        | "PROJECT_WRITE"
                        | "REPO_ADMIN"
                        | "REPO_CREATE"
                        | "REPO_READ"
                        | "REPO_WRITE"
                        | "SYS_ADMIN"
                        | "USER_ADMIN";
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        repository?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            origin?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            partition?: number;
                            project?: {
                                avatar?: (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: string; permission: string; projectKey: string; repositorySlug: string; }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update repository SSH key permission
Description
Updates the permission granted to the specified SSH key to the repository identified in the URL.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: string; permission: string; projectKey: string; repositorySlug: string; }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { keyId: string; permission: string; projectKey: string; repositorySlug: string; }
 - ReadonlykeyId: string
 Description
 The newly created access key
 - Readonlypermission: string
 Description
 The new permission to be granted to the SSH key
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created access key.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions on the repository to edit its access keys.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlytrace?: undefined

`Readonly/keys/latest/projects/{projectKey}/ssh`

"/keys/latest/projects/{projectKey}/ssh": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: {
                filter?: string;
                limit?: number;
                permission?: string;
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            key?: {
                                algorithmType?: ...;
                                bitLength?: ...;
                                createdDate?: ...;
                                expiryDays?: ...;
                                fingerprint?: ...;
                                id?: ...;
                                label?: ...;
                                lastAuthenticated?: ...;
                                text?: ...;
                            };
                            permission?: | "ADMIN"
                            | "LICENSED_USER"
                            | "PROJECT_ADMIN"
                            | "PROJECT_CREATE"
                            | "PROJECT_READ"
                            | "PROJECT_VIEW"
                            | "PROJECT_WRITE"
                            | "REPO_ADMIN"
                            | "REPO_CREATE"
                            | "REPO_READ"
                            | "REPO_WRITE"
                            | "SYS_ADMIN"
                            | "USER_ADMIN";
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            repository?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                origin?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    key?: {
                        algorithmType?: string;
                        bitLength?: number;
                        createdDate?: string;
                        expiryDays?: number;
                        fingerprint?: string;
                        id?: number;
                        label?: string;
                        lastAuthenticated?: string;
                        text?: string;
                    };
                    permission?: | "ADMIN"
                    | "LICENSED_USER"
                    | "PROJECT_ADMIN"
                    | "PROJECT_CREATE"
                    | "PROJECT_READ"
                    | "PROJECT_VIEW"
                    | "PROJECT_WRITE"
                    | "REPO_ADMIN"
                    | "REPO_CREATE"
                    | "REPO_READ"
                    | "REPO_WRITE"
                    | "SYS_ADMIN"
                    | "USER_ADMIN";
                    project?: {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                    repository?: {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        origin?: {
                            archived?: (...) | (...) | (...);
                            defaultBranch?: (...) | (...);
                            description?: (...) | (...);
                            forkable?: (...) | (...) | (...);
                            hierarchyId?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            partition?: (...) | (...);
                            project?: (...) | (...);
                            public?: (...) | (...) | (...);
                            relatedLinks?: (...) | (...);
                            scmId?: (...) | (...);
                            scope?: (...) | (...);
                            slug?: (...) | (...);
                            state?: (...) | (...) | (...) | (...) | (...);
                            statusMessage?: (...) | (...);
                        };
                        partition?: number;
                        project?: {
                            avatar?: (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            description?: (...) | (...);
                            id?: (...) | (...);
                            key: string;
                            links?: (...) | (...);
                            name?: (...) | (...);
                            public?: (...) | (...) | (...);
                            scope?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        key?: {
                            algorithmType?: string;
                            bitLength?: number;
                            createdDate?: string;
                            expiryDays?: number;
                            fingerprint?: string;
                            id?: number;
                            label?: string;
                            lastAuthenticated?: string;
                            text?: string;
                        };
                        permission?: | "ADMIN"
                        | "LICENSED_USER"
                        | "PROJECT_ADMIN"
                        | "PROJECT_CREATE"
                        | "PROJECT_READ"
                        | "PROJECT_VIEW"
                        | "PROJECT_WRITE"
                        | "REPO_ADMIN"
                        | "REPO_CREATE"
                        | "REPO_READ"
                        | "REPO_WRITE"
                        | "SYS_ADMIN"
                        | "USER_ADMIN";
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        repository?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            origin?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            partition?: number;
                            project?: {
                                avatar?: (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; permission?: string; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get SSH key
Description
Retrieves the access keys for the project identified in the URL.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { filter?: string; limit?: number; permission?: string; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: { filter?: string; limit?: number; permission?: string; start?: number }
 - Optional Readonlyfilter?: string
 Description
 If specified only SSH access keys with a label prefixed with the supplied string will be returned.
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlypermission?: string
 Description
 If specified only SSH access keys with at least the supplied permission will be returned Default is PROJECT_READ.
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { key?: { algorithmType?: ...; bitLength?: ...; createdDate?: ...; expiryDays?: ...; fingerprint?: ...; id?: ...; label?: ...; lastAuthenticated?: ...; text?: ...; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; repository?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; origin?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A single page of access keys associated with the project.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the access keys for this project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }; requestBody?: { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; }; responses: { "201": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add project SSH key
Description
Register a new SSH key and grants access to the project identified in the URL.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; }
- Readonlyresponses: { "201": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created access key.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The current request contains invalid or missing values.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to add an access key to the project.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/keys/latest/projects/{projectKey}/ssh/{keyId}`

"/keys/latest/projects/{projectKey}/ssh/{keyId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { keyId: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { keyId: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        key?: {
                            algorithmType?: string;
                            bitLength?: number;
                            createdDate?: string;
                            expiryDays?: number;
                            fingerprint?: string;
                            id?: number;
                            label?: string;
                            lastAuthenticated?: string;
                            text?: string;
                        };
                        permission?: | "ADMIN"
                        | "LICENSED_USER"
                        | "PROJECT_ADMIN"
                        | "PROJECT_CREATE"
                        | "PROJECT_READ"
                        | "PROJECT_VIEW"
                        | "PROJECT_WRITE"
                        | "REPO_ADMIN"
                        | "REPO_CREATE"
                        | "REPO_READ"
                        | "REPO_WRITE"
                        | "SYS_ADMIN"
                        | "USER_ADMIN";
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        repository?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            origin?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            partition?: number;
                            project?: {
                                avatar?: (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Revoke project SSH key
Description
Remove an existing access key for the project identified in the URL. If the same SSH key is used as an access key for multiple projects or repositories, only the access to the project identified in the URL will be revoked.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { keyId: string; projectKey: string }
 - ReadonlykeyId: string
 Description
 The key id
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The access key was deleted (or none was found matching the given id).
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to remove access keys for this project.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get project SSH key
Description
Retrieves the access key for the SSH key with id keyId on the project identified in the URL.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { keyId: string; projectKey: string }
 - ReadonlykeyId: string
 Description
 The key id
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The access key for the repository and SSH key with ID keyId.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the access keys for this repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository or key does not exist or the key does not have access on the repository.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/keys/latest/projects/{projectKey}/ssh/{keyId}/permission/{permission}`

"/keys/latest/projects/{projectKey}/ssh/{keyId}/permission/{permission}": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { keyId: string; permission: string; projectKey: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        key?: {
                            algorithmType?: string;
                            bitLength?: number;
                            createdDate?: string;
                            expiryDays?: number;
                            fingerprint?: string;
                            id?: number;
                            label?: string;
                            lastAuthenticated?: string;
                            text?: string;
                        };
                        permission?: | "ADMIN"
                        | "LICENSED_USER"
                        | "PROJECT_ADMIN"
                        | "PROJECT_CREATE"
                        | "PROJECT_READ"
                        | "PROJECT_VIEW"
                        | "PROJECT_WRITE"
                        | "REPO_ADMIN"
                        | "REPO_CREATE"
                        | "REPO_READ"
                        | "REPO_WRITE"
                        | "SYS_ADMIN"
                        | "USER_ADMIN";
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        repository?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            origin?: {
                                archived?: (...) | (...) | (...);
                                defaultBranch?: (...) | (...);
                                description?: (...) | (...);
                                forkable?: (...) | (...) | (...);
                                hierarchyId?: (...) | (...);
                                id?: (...) | (...);
                                links?: (...) | (...);
                                name?: (...) | (...);
                                partition?: (...) | (...);
                                project?: (...) | (...);
                                public?: (...) | (...) | (...);
                                relatedLinks?: (...) | (...);
                                scmId?: (...) | (...);
                                scope?: (...) | (...);
                                slug?: (...) | (...);
                                state?: (...) | (...) | (...) | (...) | (...);
                                statusMessage?: (...) | (...);
                            };
                            partition?: number;
                            project?: {
                                avatar?: (...)
                                | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: string; permission: string; projectKey: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update project SSH key permission
Description
Updates the permission granted to the specified SSH key to the project identified in the URL.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: string; permission: string; projectKey: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { keyId: string; permission: string; projectKey: string }
 - ReadonlykeyId: string
 Description
 The newly created access key
 - Readonlypermission: string
 Description
 The new permission to be granted to the SSH key
 - ReadonlyprojectKey: string
 Description
 The project key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { key?: { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; permission?: | "ADMIN" | "LICENSED_USER" | "PROJECT_ADMIN" | "PROJECT_CREATE" | "PROJECT_READ" | "PROJECT_VIEW" | "PROJECT_WRITE" | "REPO_ADMIN" | "REPO_CREATE" | "REPO_READ" | "REPO_WRITE" | "SYS_ADMIN" | "USER_ADMIN"; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repository?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created access key.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions on the project to edit its access keys.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified project does not exist.
Optional Readonlytrace?: undefined

`Readonly/keys/latest/ssh/{keyId}`

"/keys/latest/ssh/{keyId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { keyId: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    projects?: {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key?: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                    repositories?: {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        origin?: {
                            archived?: (...) | (...) | (...);
                            defaultBranch?: (...) | (...);
                            description?: (...) | (...);
                            forkable?: (...) | (...) | (...);
                            hierarchyId?: (...) | (...);
                            id?: (...) | (...);
                            links?: (...) | (...);
                            name?: (...) | (...);
                            partition?: (...) | (...);
                            project?: (...) | (...);
                            public?: (...) | (...) | (...);
                            relatedLinks?: (...) | (...);
                            scmId?: (...) | (...);
                            scope?: (...) | (...);
                            slug?: (...) | (...);
                            state?: (...) | (...) | (...) | (...) | (...);
                            statusMessage?: (...) | (...);
                        };
                        partition?: number;
                        project?: {
                            avatar?: (...)
                            | (...);
                            avatarUrl?: (...) | (...);
                            description?: (...) | (...);
                            id?: (...) | (...);
                            key: string;
                            links?: (...) | (...);
                            name?: (...) | (...);
                            public?: (...) | (...) | (...);
                            scope?: (...) | (...);
                            type?: (...) | (...) | (...);
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: string }; query?: undefined; }; requestBody?: { content: { "application/json": { projects?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repositories?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Revoke project SSH key
Description
Remove an existing access key for the projects and repositories in the submitted entity. If the same SSH key is used as an access key for multiple projects or repositories not supplied, only the access to the projects or repositories identified will be revoked.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { keyId: string }
 - ReadonlykeyId: string
 Description
 The identifier of the SSH key
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { projects?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; repositories?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: (...) | (...) | (...); defaultBranch?: (...) | (...); description?: (...) | (...); forkable?: (...) | (...) | (...); hierarchyId?: (...) | (...); id?: (...) | (...); links?: (...) | (...); name?: (...) | (...); partition?: (...) | (...); project?: (...) | (...); public?: (...) | (...) | (...); relatedLinks?: (...) | (...); scmId?: (...) | (...); scope?: (...) | (...); slug?: (...) | (...); state?: (...) | (...) | (...) | (...) | (...); statusMessage?: (...) | (...); }; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; }; }
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The access keys were deleted (or none was found matching the given id and repositories or projects).
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to remove access keys for one or more of the specified projects or repositories.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 On or more of the specified repositories or projects does not exist or the key itself does not exist.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/keys/latest/ssh/{keyId}/projects`

"/keys/latest/ssh/{keyId}/projects": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { keyId: number };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: number }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get project SSH keys
Description
Retrieves all project-related access keys for the SSH key with id keyId. If the current user is not an admin any of the projects the key provides access to, none are returned.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: number }; query?: undefined; }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The SSH key with ID keyId.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified key does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/keys/latest/ssh/{keyId}/repos`

"/keys/latest/ssh/{keyId}/repos": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { keyId: string };
            query?: { withRestrictions?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: string }; query?: { withRestrictions?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository SSH key
Description
Retrieves all repository-related access keys for the SSH key with id keyId. If the current user is not an admin of any of the projects the key provides access to, none are returned.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: string }; query?: { withRestrictions?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { keyId: string }
 - ReadonlykeyId: string
 Description
 The key id
 - Optional Readonlyquery?: { withRestrictions?: string }
 - Optional ReadonlywithRestrictions?: string
 Description
 Include the readOnly field. The readOnly field is contextual for the user making the request. readOnly returns true if there is a restriction and the user does not havePROJECT_ADMIN access for the repository the key is associated with.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The SSH key with ID keyId.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified key does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/account/settings/preferred-mirror`

"/mirroring/latest/account/settings/preferred-mirror": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        baseUrl?: string;
                        enabled?: boolean;
                        id?: string;
                        lastSeenDate?: string;
                        mirrorType?: "FARM"
                        | "SINGLE";
                        name?: string;
                        productVersion?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: { content: { "application/json": string } };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; }; }
Remove preferred mirror
Description
Removes the current user's preferred mirror
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>> } }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 an empty response indicating that the user setting has been updated
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get preferred mirror
Description
Retrieves the current user's preferred mirror server
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 the preferred mirror server
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user's preferred mirror server could not be found.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": string } }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Set preferred mirror
Description
Sets the mirror specified by a mirror ID as the current user's preferred mirror
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": string } }
 Description
 the mirror ID
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 an empty response indicating that the user setting has been updated
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The mirror could not be found.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/analyticsSettings`

"/mirroring/latest/analyticsSettings": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        canCollectAnalytics?: boolean;
                        serverTime?: number;
                        supportEntitlementNumber?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { canCollectAnalytics?: boolean; serverTime?: number; supportEntitlementNumber?: string; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get analytics settings from upstream
Description
Gets the analytics settings from the mirroring upstream
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { canCollectAnalytics?: boolean; serverTime?: number; supportEntitlementNumber?: string; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { canCollectAnalytics?: boolean; serverTime?: number; supportEntitlementNumber?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The analytics settings from upstream
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/authenticate`

"/mirroring/latest/authenticate": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    credentials: | { token: string }
                    | { algorithm?: string; publicKey: string; username?: string }
                    | { password: string; username: string };
                    repositoryId?: number;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        active?: boolean;
                        avatarUrl?: string;
                        displayName?: string;
                        effectivePermissions?: Record<string, unknown>;
                        emailAddress?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        slug?: string;
                        type?: "NORMAL" | "SERVICE";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { credentials: | { token: string } | { algorithm?: string; publicKey: string; username?: string } | { password: string; username: string }; repositoryId?: number; }; }; }; responses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; effectivePermissions?: Record<string, unknown>; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Authenticate on behalf of a user
Description
Authenticates on behalf of a user. Used by mirrors to check the credentials supplied to them by users. If successful a user and their effective permissions are returned as follows -
* For SSH credentials - all the effective user permissions are returned. * For all other credentials - the highest global permission is returned along with highest repository permission if repository ID is also provided in the request. Currently only username/password, bearer token and SSH credentials are supported.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { credentials: | { token: string } | { algorithm?: string; publicKey: string; username?: string } | { password: string; username: string }; repositoryId?: number; }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; effectivePermissions?: Record<string, unknown>; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { active?: boolean; avatarUrl?: string; displayName?: string; effectivePermissions?: Record<string, unknown>; emailAddress?: string; id?: number; links?: Record<string, unknown>; name?: string; slug?: string; type?: "NORMAL" | "SERVICE"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The user for the supplied credentials and their effective permissions}.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 If the supplied credentials are incomplete or not understood.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user is not permitted to authenticate on behalf of users or authentication with the supplied user credentials failed for some reason
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/farmNodes`

"/mirroring/latest/farmNodes": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json;charset=UTF-8": readonly {
                        address?: { address?: string; port?: number };
                        buildVersion?: string;
                        id?: string;
                        local?: boolean;
                        name?: string;
                    }[];
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json;charset=UTF-8": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json;charset=UTF-8": readonly { address?: { address?: string; port?: number }; buildVersion?: string; id?: string; local?: boolean; name?: string; }[]; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get farm nodes
Description
Retrieves the list of farm nodes in this cluster
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json;charset=UTF-8": readonly { address?: { address?: string; port?: number }; buildVersion?: string; id?: string; local?: boolean; name?: string; }[]; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json;charset=UTF-8": readonly { address?: { address?: string; port?: number }; buildVersion?: string; id?: string; local?: boolean; name?: string; }[]; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The list of farm nodes
 - Readonly404: { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server could not be found
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/mirrorRepos/{externalRepositoryId}`

"/mirroring/latest/mirrorRepos/{externalRepositoryId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { externalRepositoryId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        available?: boolean;
                        cloneUrls?: readonly { href?: string; name?: string }[];
                        lastUpdated?: string;
                        mirrorName?: string;
                        pushUrls?: readonly { href?: string; name?: string }[];
                        repositoryId?: string;
                        status?:
                            | "AVAILABLE"
                            | "ERROR_AVAILABLE"
                            | "ERROR_INITIALIZING"
                            | "INITIALIZING"
                            | "NOT_MIRRORED";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { externalRepositoryId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { available?: boolean; cloneUrls?: readonly { href?: string; name?: string }[]; lastUpdated?: string; mirrorName?: string; pushUrls?: readonly { href?: string; name?: string }[]; repositoryId?: string; status?: | "AVAILABLE" | "ERROR_AVAILABLE" | "ERROR_INITIALIZING" | "INITIALIZING" | "NOT_MIRRORED"; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get clone URLs
Description
Retrieves all available clone urls for the specified repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { externalRepositoryId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { externalRepositoryId: string }
 - ReadonlyexternalRepositoryId: string
 Description
 the repository ID
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { available?: boolean; cloneUrls?: readonly { href?: string; name?: string }[]; lastUpdated?: string; mirrorName?: string; pushUrls?: readonly { href?: string; name?: string }[]; repositoryId?: string; status?: | "AVAILABLE" | "ERROR_AVAILABLE" | "ERROR_INITIALIZING" | "INITIALIZING" | "NOT_MIRRORED"; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { available?: boolean; cloneUrls?: readonly { href?: string; name?: string }[]; lastUpdated?: string; mirrorName?: string; pushUrls?: readonly { href?: string; name?: string }[]; repositoryId?: string; status?: | "AVAILABLE" | "ERROR_AVAILABLE" | "ERROR_INITIALIZING" | "INITIALIZING" | "NOT_MIRRORED"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The mirrored repository's information.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server or the repository could not be found.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/mirrorServers`

"/mirroring/latest/mirrorServers": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            baseUrl?: string;
                            enabled?: boolean;
                            id?: string;
                            lastSeenDate?: string;
                            mirrorType?: "FARM"
                            | "SINGLE";
                            name?: string;
                            productVersion?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all mirrors
Description
Returns a list of mirrors
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 a page of mirrors
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/mirrorServers/{mirrorId}`

"/mirroring/latest/mirrorServers/{mirrorId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { mirrorId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { mirrorId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        baseUrl?: string;
                        enabled?: boolean;
                        id?: string;
                        lastSeenDate?: string;
                        mirrorType?: "FARM"
                        | "SINGLE";
                        name?: string;
                        productVersion?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { mirrorId: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": { baseUrl?: string; productVersion?: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        baseUrl?: string;
                        enabled?: boolean;
                        id?: string;
                        lastSeenDate?: string;
                        mirrorType?: "FARM"
                        | "SINGLE";
                        name?: string;
                        productVersion?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { mirrorId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; }; }
Delete mirror by ID
Description
Removes a mirror, disabling all access and notifications for the mirror server in question
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { mirrorId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { mirrorId: string }
 - ReadonlymirrorId: string
 Description
 the ID of the mirror to remove
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>> } }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 an empty response indicating that the mirror has been removed
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { mirrorId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get mirror by ID
Description
Returns the mirror specified by a mirror ID
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { mirrorId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { mirrorId: string }
 - ReadonlymirrorId: string
 Description
 the mirror ID
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 the mirror
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The mirror could not be found.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { mirrorId: string }; query?: undefined; }; requestBody?: { content: { "application/json": { baseUrl?: string; productVersion?: string }; }; }; responses: { "200": { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Upgrade mirror server
Description
Upgrades the mirror server in question with the provided details.This endpoint can only be called by the mirror instance or system administrators Since 5.8
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { mirrorId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { mirrorId: string }
 - ReadonlymirrorId: string
 Description
 the ID of the mirror to upgrade
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { baseUrl?: string; productVersion?: string }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 the mirror
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/mirrorServers/{mirrorId}/events`

"/mirroring/latest/mirrorServers/{mirrorId}/events": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { mirrorId: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    mirrorRepoId?: number;
                    type?: "SYNCHRONIZATION_FAILED"
                    | "SYNCHRONIZED";
                    upstreamRepoId?: string;
                };
            };
        };
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { mirrorId: string }; query?: undefined; }; requestBody?: { content: { "application/json": { mirrorRepoId?: number; type?: "SYNCHRONIZATION_FAILED" | "SYNCHRONIZED"; upstreamRepoId?: string; }; }; }; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Publish RepositoryMirrorEvent
Description
Publishes a RepositoryMirrorEvent on the event queue.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { mirrorId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { mirrorId: string }
 - ReadonlymirrorId: string
 Description
 the server id of the mirror that raised this event
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { mirrorRepoId?: number; type?: "SYNCHRONIZATION_FAILED" | "SYNCHRONIZED"; upstreamRepoId?: string; }; }; }
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The event was successfully placed on the queue
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/progress`

"/mirroring/latest/progress": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        discovering?: boolean;
                        syncedRepos?: number;
                        totalRepos?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { discovering?: boolean; syncedRepos?: number; totalRepos?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get synchronization progress state
Description
Retrieves synchronization progress state.If there's no progress to report, this resource will return
```
 {"discovering":false,"syncedRepos":0,"totalRepos":0}
```
If there are repositories in the process of synchronizing, but the precise number hasn't been discovered yet, this resource will return: {"discovering":true,"syncedRepos":3,"totalRepos":100} If there is progress to report and the total number of repositories is known, this resource will return: {"discovering":false,"syncedRepos":242,"totalRepos":1071}
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { discovering?: boolean; syncedRepos?: number; totalRepos?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { discovering?: boolean; syncedRepos?: number; totalRepos?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 the synchronization progress state
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server could not be found.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/projects/{projectId}`

"/mirroring/latest/projects/{projectId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatar?: string;
                        avatarUrl?: string;
                        description?: string;
                        id?: number;
                        key?: string;
                        links?: Record<string, unknown>;
                        name?: string;
                        public?: boolean;
                        scope?: string;
                        type?: "NORMAL" | "PERSONAL";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get project
Description
Returns the requested project using its primary key ID. Since 6.7
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectId: string }
 - ReadonlyprojectId: string
 Description
 the ID of the requested project
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { avatar?: string; avatarUrl?: string; description?: string; id?: number; key?: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The project with the specified ID
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Project not found
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/projects/{projectId}/repos`

"/mirroring/latest/projects/{projectId}/repos": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectId: string };
            query?: {
                includeDefaultBranch?: "true" | "false";
                limit?: number;
                start?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<(...), (...)>;
                            name?: string;
                            origin?: {
                                archived?: ...;
                                defaultBranch?: ...;
                                description?: ...;
                                forkable?: ...;
                                hierarchyId?: ...;
                                id?: ...;
                                links?: ...;
                                name?: ...;
                                partition?: ...;
                                project?: ...;
                                public?: ...;
                                relatedLinks?: ...;
                                scmId?: ...;
                                scope?: ...;
                                slug?: ...;
                                state?: ...;
                                statusMessage?: ...;
                            };
                            partition?: number;
                            project?: {
                                avatar?: ...;
                                avatarUrl?: ...;
                                description?: ...;
                                id?: ...;
                                key: ...;
                                links?: ...;
                                name?: ...;
                                public?: ...;
                                scope?: ...;
                                type?: ...;
                            };
                            properties?: {
                                contentHash?: ...;
                                defaultBranchId?: ...;
                                metadataHash?: ...;
                            };
                            public?: boolean;
                            relatedLinks?: Record<(...), (...)>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectId: string }; query?: { includeDefaultBranch?: "true" | "false"; limit?: number; start?: number; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; properties?: { contentHash?: ...; defaultBranchId?: ...; metadataHash?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get hashes for repositories in project
Description
Returns a page of repositories for a given project, enriched with a content hash
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectId: string }; query?: { includeDefaultBranch?: "true" | "false"; limit?: number; start?: number; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectId: string }
 - ReadonlyprojectId: string
 Description
 the id of the requested project
 - Optional Readonlyquery?: { includeDefaultBranch?: "true" | "false"; limit?: number; start?: number }
 - Optional ReadonlyincludeDefaultBranch?: "true" | "false"
 Description
 includes defaultBranchId in the response, if true. Default value is false
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; properties?: { contentHash?: ...; defaultBranchId?: ...; metadataHash?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<(...), (...)>; name?: string; origin?: { archived?: ...; defaultBranch?: ...; description?: ...; forkable?: ...; hierarchyId?: ...; id?: ...; links?: ...; name?: ...; partition?: ...; project?: ...; public?: ...; relatedLinks?: ...; scmId?: ...; scope?: ...; slug?: ...; state?: ...; statusMessage?: ...; }; partition?: number; project?: { avatar?: ...; avatarUrl?: ...; description?: ...; id?: ...; key: ...; links?: ...; name?: ...; public?: ...; scope?: ...; type?: ...; }; properties?: { contentHash?: ...; defaultBranchId?: ...; metadataHash?: ...; }; public?: boolean; relatedLinks?: Record<(...), (...)>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of repositories with content hashes
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Mirroring is not available
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/repos`

"/mirroring/latest/repos": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { includeDefaultBranch?: "true" | "false" };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        origin?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            partition?: number;
                            project?: {
                                avatar?: (...) | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                        partition?: number;
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        properties?: {
                            contentHash?: string;
                            defaultBranchId?: string;
                            metadataHash?: string;
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { includeDefaultBranch?: "true" | "false" }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; properties?: { contentHash?: string; defaultBranchId?: string; metadataHash?: string; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get content hashes for repositories
Description
Returns a page of repositories enriched with a content hash and default branch
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { includeDefaultBranch?: "true" | "false" }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { includeDefaultBranch?: "true" | "false" }
 - Optional ReadonlyincludeDefaultBranch?: "true" | "false"
 Description
 includes defaultBranchId for each repository in the response, if true. Default value is false.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; properties?: { contentHash?: string; defaultBranchId?: string; metadataHash?: string; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; properties?: { contentHash?: string; defaultBranchId?: string; metadataHash?: string; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of repositories with content hashes and default branch
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Mirroring is not available
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/repos/{repoId}`

"/mirroring/latest/repos/{repoId}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { repoId: string };
            query?: { includeDefaultBranch?: boolean };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        archived?: boolean;
                        defaultBranch?: string;
                        description?: string;
                        forkable?: boolean;
                        hierarchyId?: string;
                        id?: number;
                        links?: Record<string, unknown>;
                        name?: string;
                        origin?: {
                            archived?: boolean;
                            defaultBranch?: string;
                            description?: string;
                            forkable?: boolean;
                            hierarchyId?: string;
                            id?: number;
                            links?: Record<string, unknown>;
                            name?: string;
                            partition?: number;
                            project?: {
                                avatar?: (...) | (...);
                                avatarUrl?: (...) | (...);
                                description?: (...) | (...);
                                id?: (...) | (...);
                                key: string;
                                links?: (...) | (...);
                                name?: (...) | (...);
                                public?: (...) | (...) | (...);
                                scope?: (...) | (...);
                                type?: (...) | (...) | (...);
                            };
                            public?: boolean;
                            relatedLinks?: Record<string, unknown>;
                            scmId?: string;
                            scope?: string;
                            slug?: string;
                            state?:
                                | "AVAILABLE"
                                | "INITIALISATION_FAILED"
                                | "INITIALISING"
                                | "OFFLINE";
                            statusMessage?: string;
                        };
                        partition?: number;
                        project?: {
                            avatar?: string;
                            avatarUrl?: string;
                            description?: string;
                            id?: number;
                            key: string;
                            links?: Record<string, unknown>;
                            name?: string;
                            public?: boolean;
                            scope?: string;
                            type?: "NORMAL" | "PERSONAL";
                        };
                        properties?: {
                            contentHash?: string;
                            defaultBranchId?: string;
                            metadataHash?: string;
                        };
                        public?: boolean;
                        relatedLinks?: Record<string, unknown>;
                        scmId?: string;
                        scope?: string;
                        slug?: string;
                        state?:
                            | "AVAILABLE"
                            | "INITIALISATION_FAILED"
                            | "INITIALISING"
                            | "OFFLINE";
                        statusMessage?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { repoId: string }; query?: { includeDefaultBranch?: boolean }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; properties?: { contentHash?: string; defaultBranchId?: string; metadataHash?: string; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get content hash for a repository
Description
Returns a repository enriched with a content hash and default branch
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { repoId: string }; query?: { includeDefaultBranch?: boolean }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { repoId: string }
 - ReadonlyrepoId: string
 Description
 the ID of the requested repository
 - Optional Readonlyquery?: { includeDefaultBranch?: boolean }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; properties?: { contentHash?: string; defaultBranchId?: string; metadataHash?: string; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; origin?: { archived?: boolean; defaultBranch?: string; description?: string; forkable?: boolean; hierarchyId?: string; id?: number; links?: Record<string, unknown>; name?: string; partition?: number; project?: { avatar?: (...) | (...); avatarUrl?: (...) | (...); description?: (...) | (...); id?: (...) | (...); key: string; links?: (...) | (...); name?: (...) | (...); public?: (...) | (...) | (...); scope?: (...) | (...); type?: (...) | (...) | (...); }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; partition?: number; project?: { avatar?: string; avatarUrl?: string; description?: string; id?: number; key: string; links?: Record<string, unknown>; name?: string; public?: boolean; scope?: string; type?: "NORMAL" | "PERSONAL"; }; properties?: { contentHash?: string; defaultBranchId?: string; metadataHash?: string; }; public?: boolean; relatedLinks?: Record<string, unknown>; scmId?: string; scope?: string; slug?: string; state?: | "AVAILABLE" | "INITIALISATION_FAILED" | "INITIALISING" | "OFFLINE"; statusMessage?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The repository with the specified repoId
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Repository not found
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/repos/{repoId}/mirrors`

"/mirroring/latest/repos/{repoId}/mirrors": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { repoId: string };
            query?: { preAuthorized?: boolean };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        links?: Record<string, unknown>;
                        mirrorServer?: {
                            baseUrl?: string;
                            enabled?: boolean;
                            id?: string;
                            lastSeenDate: string;
                            mirrorType?: "FARM" | "SINGLE";
                            name?: string;
                            productVersion?: string;
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { repoId: string }; query?: { preAuthorized?: boolean }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { links?: Record<string, unknown>; mirrorServer?: { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get mirrors for repository
Description
Returns a page of mirrors for a repository. This resource will return all mirrors along with authorized links to the mirror's repository REST resource. To determine if a repository is available on the mirror, the returned URL needs to be called.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { repoId: string }; query?: { preAuthorized?: boolean }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { repoId: string }
 - ReadonlyrepoId: string
 Description
 the ID of the requested repository
 - Optional Readonlyquery?: { preAuthorized?: boolean }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { links?: Record<string, unknown>; mirrorServer?: { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { links?: Record<string, unknown>; mirrorServer?: { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The mirrored repository descriptor
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Mirroring is not available
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/requests`

"/mirroring/latest/requests": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: number;
                start?: number;
                state?: "ACCEPTED" | "PENDING" | "REJECTED";
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            id?: number;
                            mirrorBaseUrl?: string;
                            mirrorId?: string;
                            mirrorName?: string;
                            mirrorType?: "FARM"
                            | "SINGLE";
                            productVersion?: string;
                            state?: "ACCEPTED" | "PENDING" | "REJECTED";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    id?: number;
                    mirrorBaseUrl?: string;
                    mirrorId?: string;
                    mirrorName?: string;
                    mirrorType?: "FARM"
                    | "SINGLE";
                    productVersion?: string;
                    state?: "ACCEPTED" | "PENDING" | "REJECTED";
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        mirrorBaseUrl?: string;
                        mirrorId?: string;
                        mirrorName?: string;
                        mirrorType?: "FARM"
                        | "SINGLE";
                        productVersion?: string;
                        state?: "ACCEPTED" | "PENDING" | "REJECTED";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get mirroring requests
Description
Retrieves a mirroring request
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; start?: number; state?: "ACCEPTED" | "PENDING" | "REJECTED" }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlystate?: "ACCEPTED" | "PENDING" | "REJECTED"
 Description
 (optional) the request state to filter on
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of mirroring requests
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }; }; }; responses: { "200": { content: { "application/json": { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create a mirroring request
Description
Creates a new mirroring request
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The created mirroring request
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was invalid or missing
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/requests/{mirroringRequestId}`

"/mirroring/latest/requests/{mirroringRequestId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { mirroringRequestId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { mirroringRequestId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        id?: number;
                        mirrorBaseUrl?: string;
                        mirrorId?: string;
                        mirrorName?: string;
                        mirrorType?: "FARM"
                        | "SINGLE";
                        productVersion?: string;
                        state?: "ACCEPTED" | "PENDING" | "REJECTED";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { mirroringRequestId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a mirroring request
Description
Deletes a mirroring request
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { mirroringRequestId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { mirroringRequestId: string }
 - ReadonlymirroringRequestId: string
 Description
 the ID of the mirroring request to delete
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The request was deleted
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request could not be found
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { mirroringRequestId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get a mirroring request
Description
Retrieves a mirroring request
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { mirroringRequestId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { mirroringRequestId: string }
 - ReadonlymirroringRequestId: string
 Description
 the ID of the mirroring request to retrieve
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { id?: number; mirrorBaseUrl?: string; mirrorId?: string; mirrorName?: string; mirrorType?: "FARM" | "SINGLE"; productVersion?: string; state?: "ACCEPTED" | "PENDING" | "REJECTED"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The mirroring request
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request could not be found
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/requests/{mirroringRequestId}/accept`

"/mirroring/latest/requests/{mirroringRequestId}/accept": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { mirroringRequestId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        baseUrl?: string;
                        enabled?: boolean;
                        id?: string;
                        lastSeenDate?: string;
                        mirrorType?: "FARM"
                        | "SINGLE";
                        name?: string;
                        productVersion?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { mirroringRequestId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Accept a mirroring request
Description
Accepts a mirroring request
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { mirroringRequestId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { mirroringRequestId: string }
 - ReadonlymirroringRequestId: string
 Description
 the ID of the request to accept
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The accepted mirror server
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request could not be found
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/requests/{mirroringRequestId}/reject`

"/mirroring/latest/requests/{mirroringRequestId}/reject": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { mirroringRequestId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        baseUrl?: string;
                        enabled?: boolean;
                        id?: string;
                        lastSeenDate?: string;
                        mirrorType?: "FARM"
                        | "SINGLE";
                        name?: string;
                        productVersion?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { mirroringRequestId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Reject a mirroring request
Description
Rejects a mirroring request
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { mirroringRequestId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { mirroringRequestId: string }
 - ReadonlymirroringRequestId: string
 Description
 the ID of the request to reject
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { baseUrl?: string; enabled?: boolean; id?: string; lastSeenDate?: string; mirrorType?: "FARM" | "SINGLE"; name?: string; productVersion?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The rejected mirror server
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request could not be found
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/supportInfo/out-of-sync-repos/content`

"/mirroring/latest/supportInfo/out-of-sync-repos/content": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json;charset=UTF-8": string };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json;charset=UTF-8": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json;charset=UTF-8": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json;charset=UTF-8": string }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get out-of-sync repositories
Description
Retrieves a list of repository IDs which have not synced on the mirror node for at least the threshold time limit after the content was changed in the corresponding upstream repositories. The threshold time limit is defined by a configuration property plugin.mirroring.repository.diagnostics.sync.tolerance. The detection of out of sync repositories is dependent on the timing of a scheduled job which is controlled by a configuration property plugin.mirroring.synchronization.interval which means in worst case it can take upto plugin.mirroring.repository.diagnostics.sync.tolerance + plugin.mirroring.synchronization.interval time to detect an out-of-sync repository.
To use this API, a configuration property plugin.mirroring.repository.diagnostics.sync.enabled has to be set to true as this feature is disabled by default.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json;charset=UTF-8": string }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json;charset=UTF-8": string }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream IDs of the repositories that are out of sync on the mirror node
 - Readonly401: { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly409: { content: { "application/json;charset=UTF-8": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The feature is not enabled i.e. plugin.mirroring.repository.diagnostics.sync.enabled=false
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repo-lock-owner`

"/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repo-lock-owner": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        externalRepositoryId?: string;
                        lockAcquireTime?: string;
                        nodeId?: string;
                        requestId?: string;
                        threadName?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { externalRepositoryId?: string; lockAcquireTime?: string; nodeId?: string; requestId?: string; threadName?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get the repository lock owner for the syncing process
Description
Retrieves the information about the process owning the sync lock for this repository. The process owning the lock could be running on any of the nodes in the mirror farm
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { externalRepositoryId?: string; lockAcquireTime?: string; nodeId?: string; requestId?: string; threadName?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { externalRepositoryId?: string; lockAcquireTime?: string; nodeId?: string; requestId?: string; threadName?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The information about the repository lock owner for the syncing process, if the lock is currently being held, otherwise an empty response
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repoSyncStatus`

"/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repoSyncStatus": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        externalRepoId?: string;
                        failedSyncCount?: number;
                        hashes?: { content?: string; metadata?: string };
                        initialSyncDate?: string;
                        lastSyncDate?: string;
                        localProjectId?: number;
                        localRepoId?: number;
                        upstreamId?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { externalRepoId?: string; failedSyncCount?: number; hashes?: { content?: string; metadata?: string }; initialSyncDate?: string; lastSyncDate?: string; localProjectId?: number; localRepoId?: number; upstreamId?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Gets information about the mirrored repository
Description
Retrieves information about an external repository mirrored by the mirror server. Particularly the local ID & external ID of the repository
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key
 - ReadonlyrepositorySlug: string
 Description
 The repository slug
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { externalRepoId?: string; failedSyncCount?: number; hashes?: { content?: string; metadata?: string }; initialSyncDate?: string; lastSyncDate?: string; localProjectId?: number; localRepoId?: number; upstreamId?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { externalRepoId?: string; failedSyncCount?: number; hashes?: { content?: string; metadata?: string }; initialSyncDate?: string; lastSyncDate?: string; localProjectId?: number; localRepoId?: number; upstreamId?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The sync status of the repository on this node
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/supportInfo/refChangesQueue`

"/mirroring/latest/supportInfo/refChangesQueue": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json;charset=UTF-8": {
                        values?: readonly {
                            attempt?: number;
                            createdAt?: string;
                            externalRepoId?: string;
                            type?: "incremental"
                            | "snapshot";
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json;charset=UTF-8": { values?: readonly { attempt?: number; createdAt?: string; externalRepoId?: string; type?: "incremental" | "snapshot"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get items in ref changes queue
Description
Retrieves a list of up to plugin.mirroring.farm.max.ref.change.queue.dump.size items currently in the ref changes queue. The ref changes queue is an internal component of every mirror farm, and is shared between all nodes. When the contents of an upstream repository changes, an item is added to this queue so that the mirror farm nodes know to synchronize. The mirror farm constantly polls and removes items from this queue for processing, so it is empty most of the time.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json;charset=UTF-8": { values?: readonly { attempt?: number; createdAt?: string; externalRepoId?: string; type?: "incremental" | "snapshot"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json;charset=UTF-8": { values?: readonly { attempt?: number; createdAt?: string; externalRepoId?: string; type?: "incremental" | "snapshot"; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The contents of the ref changes queue
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/supportInfo/refChangesQueue/count`

"/mirroring/latest/supportInfo/refChangesQueue/count": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get total number of items in ref changes queue
Description
Retrieves the total number of items currently in the ref changes queue
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 The total number of items currently in the ref changes queue
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/supportInfo/repo-lock-owners`

"/mirroring/latest/supportInfo/repo-lock-owners": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json;charset=UTF-8": readonly {
                        externalRepositoryId?: string;
                        lockAcquireTime?: string;
                        nodeId?: string;
                        requestId?: string;
                        threadName?: string;
                    }[];
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json;charset=UTF-8": readonly { externalRepositoryId?: string; lockAcquireTime?: string; nodeId?: string; requestId?: string; threadName?: string; }[]; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get all the repository lock owners for the syncing process
Description
Retrieves the information about all the processes from the all the nodes in the mirror farm owning sync lock for any repository
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json;charset=UTF-8": readonly { externalRepositoryId?: string; lockAcquireTime?: string; nodeId?: string; requestId?: string; threadName?: string; }[]; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json;charset=UTF-8": readonly { externalRepositoryId?: string; lockAcquireTime?: string; nodeId?: string; requestId?: string; threadName?: string; }[]; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A list of all the repository lock owners for the syncing process
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/supportInfo/repoSyncStatus`

"/mirroring/latest/supportInfo/repoSyncStatus": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            externalRepoId?: string;
                            failedSyncCount?: number;
                            hashes?: { content?: ...; metadata?: ... };
                            initialSyncDate?: string;
                            lastSyncDate?: string;
                            localProjectId?: number;
                            localRepoId?: number;
                            upstreamId?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { externalRepoId?: string; failedSyncCount?: number; hashes?: { content?: ...; metadata?: ... }; initialSyncDate?: string; lastSyncDate?: string; localProjectId?: number; localRepoId?: number; upstreamId?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get sync status of repositories
Description
Retrieves a page of sync statuses of the repositories on this mirror node
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { externalRepoId?: string; failedSyncCount?: number; hashes?: { content?: ...; metadata?: ... }; initialSyncDate?: string; lastSyncDate?: string; localProjectId?: number; localRepoId?: number; upstreamId?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { externalRepoId?: string; failedSyncCount?: number; hashes?: { content?: ...; metadata?: ... }; initialSyncDate?: string; lastSyncDate?: string; localProjectId?: number; localRepoId?: number; upstreamId?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The sync status of the repositories on this node
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to call this resource.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/syncSettings`

"/mirroring/latest/syncSettings": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        mode?: "ALL_PROJECTS"
                        | "SELECTED_PROJECTS";
                        projectIds?: readonly string[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    mode?: "ALL_PROJECTS"
                    | "SELECTED_PROJECTS";
                    projectIds?: readonly string[];
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        mode?: "ALL_PROJECTS"
                        | "SELECTED_PROJECTS";
                        projectIds?: readonly string[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { mode?: "ALL_PROJECTS" | "SELECTED_PROJECTS"; projectIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get upstream settings
Description
Retrieves upstream settings
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { mode?: "ALL_PROJECTS" | "SELECTED_PROJECTS"; projectIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { mode?: "ALL_PROJECTS" | "SELECTED_PROJECTS"; projectIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 the mirror settings
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 When the user is not a service user for the currently registered upstream or doesn't have ADMIN permission
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server could not be found.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { mode?: "ALL_PROJECTS" | "SELECTED_PROJECTS"; projectIds?: readonly string[]; }; }; }; responses: { "200": { content: { "application/json": { mode?: "ALL_PROJECTS" | "SELECTED_PROJECTS"; projectIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update upstream settings
Description
Sets the settings for the specified upstream
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { mode?: "ALL_PROJECTS" | "SELECTED_PROJECTS"; projectIds?: readonly string[]; }; }; }
 Description
 the mirror settings to update to
- Readonlyresponses: { "200": { content: { "application/json": { mode?: "ALL_PROJECTS" | "SELECTED_PROJECTS"; projectIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { mode?: "ALL_PROJECTS" | "SELECTED_PROJECTS"; projectIds?: readonly string[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 the updated mirror settings
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 When the user is not a service user for the currently registered upstream or doesn't have ADMIN permission
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server could not be found.
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/syncSettings/mode`

"/mirroring/latest/syncSettings/mode": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: { content: { "application/json": string } };
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get mirror mode
Description
Gets the current mirror mode
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 the current mirror mode
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 When the user is not a service user for the currently registered upstream or doesn't have ADMIN permission
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server could not be found.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": string } }; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update mirror mode
Description
Sets the mirror mode for the specified upstream
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": string } }
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 the mode to set
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The provided mode is invalid
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 When the user is not a service user for the currently registered upstream or doesn't have ADMIN permission
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/syncSettings/projects`

"/mirroring/latest/syncSettings/projects": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: { content: { "application/json": readonly string[] } };
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get mirrored project IDs
Description
Returns the IDs of the projects that the mirror is configured to mirror
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 the currently mirrored project IDs
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 When the user is not a service user for the currently registered upstream or doesn't have ADMIN permission
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server could not be found.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": readonly string[] } }; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add multiple projects to be mirrored
Description
Configures the mirror to mirror the provided projects
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": readonly string[] } }
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 the currently mirrored project IDs
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 When the user is not a service user for the currently registered upstream or doesn't have ADMIN permission
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server could not be found.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/syncSettings/projects/{projectId}`

"/mirroring/latest/syncSettings/projects/{projectId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": unknown };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { projectId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Stop mirroring project
Description
Configures the mirror to no longer mirror the provided project
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectId: string }
 - ReadonlyprojectId: string
 Description
 the project ID to stop mirroring
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 the request has been processed
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 When the user is not a service user for the currently registered upstream or doesn't have ADMIN permission
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server could not be found.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add project to be mirrored
Description
Configures the mirror to mirror the provided project
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectId: string }; query?: undefined; }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": unknown }; headers: Readonly<Record<string, unknown>>; }
 Description
 the currently mirrored project IDs
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 When the user is not a service user for the currently registered upstream or doesn't have ADMIN permission
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server could not be found.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/upstreamServer`

"/mirroring/latest/upstreamServer": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        baseUrl?: string;
                        id?: string;
                        state?: | "PENDING"
                        | "UNKNOWN"
                        | "REMOVED"
                        | "INITIALIZING"
                        | "INSTALLED";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { baseUrl?: string; id?: string; state?: | "PENDING" | "UNKNOWN" | "REMOVED" | "INITIALIZING" | "INSTALLED"; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get upstream server
Description
Retrieves upstream server details.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { baseUrl?: string; id?: string; state?: "PENDING" | "UNKNOWN" | "REMOVED" | "INITIALIZING" | "INSTALLED"; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { baseUrl?: string; id?: string; state?: "PENDING" | "UNKNOWN" | "REMOVED" | "INITIALIZING" | "INSTALLED"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The upstream server could not be found
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/zdu/end`

"/mirroring/latest/zdu/end": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        rollingUpgradeEnabled?: boolean;
                        version?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { rollingUpgradeEnabled?: boolean; version?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
End ZDU upgrade on mirror farm
Description
Finalizes the ZDU upgrade on the mirror farm denying heterogeneous cluster formation
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { rollingUpgradeEnabled?: boolean; version?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { rollingUpgradeEnabled?: boolean; version?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The state of the rolling upgrade which includes the current version on all the nodes in the farm.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 When the user doesn't have SYS_ADMIN permission
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/mirroring/latest/zdu/start`

"/mirroring/latest/zdu/start": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        rollingUpgradeEnabled?: boolean;
                        version?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { rollingUpgradeEnabled?: boolean; version?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Start ZDU upgrade on mirror farm
Description
Enables upgrading of individual nodes within the cluster, allowing a heterogeneous cluster formation
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { rollingUpgradeEnabled?: boolean; version?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { rollingUpgradeEnabled?: boolean; version?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The state of the rolling upgrade which includes the minimum version of all the nodes in the farm.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 When the user doesn't have SYS_ADMIN permission
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/policies/latest/admin/repos/archive`

"/policies/latest/admin/repos/archive": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        permission?: "ADMIN"
                        | "PROJECT_ADMIN"
                        | "REPO_ADMIN"
                        | "SYS_ADMIN";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    permission?: "ADMIN"
                    | "PROJECT_ADMIN"
                    | "REPO_ADMIN"
                    | "SYS_ADMIN";
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        permission?: "ADMIN"
                        | "PROJECT_ADMIN"
                        | "REPO_ADMIN"
                        | "SYS_ADMIN";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository archive policy
Description
Retrieves the repository archive policy for the instance.
The user must be authenticated to access this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A response containing the repository archive policy for the instance
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the repository archive policy
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; }; responses: { "200": { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update repository archive policy
Description
Sets the repository archive policy for the instance.
The authenticated user must have SYS_ADMIN permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; }
 Description
 The request containing the details of the policy.
- Readonlyresponses: { "200": { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A response containing the repository archive policy for the instance
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The permission was invalid or does not exist
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to set the repository archive policy
Optional Readonlytrace?: undefined

`Readonly/policies/latest/admin/repos/delete`

"/policies/latest/admin/repos/delete": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        permission?: "ADMIN"
                        | "PROJECT_ADMIN"
                        | "REPO_ADMIN"
                        | "SYS_ADMIN";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    permission?: "ADMIN"
                    | "PROJECT_ADMIN"
                    | "REPO_ADMIN"
                    | "SYS_ADMIN";
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        permission?: "ADMIN"
                        | "PROJECT_ADMIN"
                        | "REPO_ADMIN"
                        | "SYS_ADMIN";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get repository delete policy
Description
Retrieves the repository delete policy for the instance.
The user must be authenticated to access this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A response containing the repository delete policy for the instance
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to retrieve the repository delete policy
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; }; responses: { "200": { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update the repository delete policy
Description
Sets the repository delete policy for the instance.
The authenticated user must have SYS_ADMIN permission.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; }
 Description
 The request containing the details of the policy.
- Readonlyresponses: { "200": { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { permission?: "ADMIN" | "PROJECT_ADMIN" | "REPO_ADMIN" | "SYS_ADMIN"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A response containing the repository delete policy for the instance
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The permission was invalid or does not exist
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to set the repository delete policy
Optional Readonlytrace?: undefined

`Readonly/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/condition`

"/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/condition": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "*/*": {
                    buildParentKeys: readonly string[];
                    exemptRefMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            name?: (...) | (...);
                        };
                    };
                    refMatcher: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: | "BRANCH"
                            | "ANY_REF"
                            | "MODEL_BRANCH"
                            | "MODEL_CATEGORY"
                            | "PATTERN";
                            name?: string;
                        };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        buildParentKeys?: readonly string[];
                        exemptRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                        id?: number;
                        refMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "*/*": { buildParentKeys: readonly string[]; exemptRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; refMatcher: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }; responses: { "200": { content: { "application/json": { buildParentKeys?: readonly string[]; exemptRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; id?: number; refMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Create a required builds merge check
Description
Create a required build merge check for the given repository.
The authenticated user must have **REPO_ADMIN** permission for the target repository to register a required build merge check. The contents of the required build merge check request are: These fields are **required**: - **buildParentKeys**: A non-empty list of build parent keys that require green builds for this merge check to pass - **refMatcher.id**: The value to match refs against in the target branch - **refMatcher.type.id**: The type of ref matcher, one of: "ANY_REF", "BRANCH", "PATTERN", "MODEL_CATEGORY" or "MODEL_BRANCH" These fields are optional: - **exemptRefMatcher.id** The value to exempt refs in the source branch from this check - **exemptRefMatcher.type.id**: The type of exempt ref matcher, one of: "ANY_REF", "BRANCH", "PATTERN", "MODEL_CATEGORY" or "MODEL_BRANCH"
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project that the repository belongs to
 - ReadonlyrepositorySlug: string
 Description
 The repository being used
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "*/*": { buildParentKeys: readonly string[]; exemptRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; refMatcher: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }
 Description
 The request specifying the required build parent keys, ref matcher and exemption matcher
- Readonlyresponses: { "200": { content: { "application/json": { buildParentKeys?: readonly string[]; exemptRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; id?: number; refMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { buildParentKeys?: readonly string[]; exemptRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; id?: number; refMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A response containing the newly created required build merge check.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed. This could be caused because:
 - The build parent key list is empty - Either of the provided ref matchers is of an unrecognized type - Either of the provided ref matchers could not be created with the provided type and id
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create a required build merge check in this repository.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/condition/{id}`

"/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/condition/{id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: number; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: number; projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "*/*": {
                    buildParentKeys: readonly string[];
                    exemptRefMatcher?: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            name?: (...) | (...);
                        };
                    };
                    refMatcher: {
                        displayId?: string;
                        id?: string;
                        type?: {
                            id?: | "BRANCH"
                            | "ANY_REF"
                            | "MODEL_BRANCH"
                            | "MODEL_CATEGORY"
                            | "PATTERN";
                            name?: string;
                        };
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        buildParentKeys?: readonly string[];
                        exemptRefMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                        id?: number;
                        refMatcher?: {
                            displayId?: string;
                            id?: string;
                            type?: {
                                id?: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                name?: (...) | (...);
                            };
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { id: number; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete a required builds merge check
Description
Deletes a required build existing merge check, given it's ID.
The authenticated user must have **REPO_ADMIN** permission for the target repository to delete a required build merge check.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: number; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: number; projectKey: string; repositorySlug: string }
 - Readonlyid: number
 - ReadonlyprojectKey: string
 Description
 The project that the repository belongs to
 - ReadonlyrepositorySlug: string
 Description
 The repository being used
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 An empty response indicating the merge check was successfully deleted, or was never present.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete a required build merge check in this repository.
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Readonlyput: { parameters: { cookie?: undefined; header?: undefined; path: { id: number; projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "*/*": { buildParentKeys: readonly string[]; exemptRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; refMatcher: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }; responses: { "200": { content: { "application/json": { buildParentKeys?: readonly string[]; exemptRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; id?: number; refMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Update a required builds merge check
Description
Update the required builds merge check for the given ID.
The authenticated user must have **REPO_ADMIN** permission for the target repository to update a required build merge check. The contents of the required build merge check request are: These fields are **required**: - **buildParentKeys**: A non-empty list of build parent keys that require green builds for this merge check to pass - **refMatcher.id**: The value to match refs against in the target branch - **refMatcher.type.id**: The type of ref matcher, one of: "ANY_REF", "BRANCH", "PATTERN", "MODEL_CATEGORY" or "MODEL_BRANCH" These fields are optional: - **exemptRefMatcher.id** The value to exempt refs in the source branch from this check - **exemptRefMatcher.type.id**: The type of exempt ref matcher, one of: "ANY_REF", "BRANCH", "PATTERN", "MODEL_CATEGORY" or "MODEL_BRANCH"
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { id: number; projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { id: number; projectKey: string; repositorySlug: string }
 - Readonlyid: number
 - ReadonlyprojectKey: string
 Description
 The project that the repository belongs to
 - ReadonlyrepositorySlug: string
 Description
 The repository being used
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "*/*": { buildParentKeys: readonly string[]; exemptRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; refMatcher: { displayId?: string; id?: string; type?: { id?: | "BRANCH" | "ANY_REF" | "MODEL_BRANCH" | "MODEL_CATEGORY" | "PATTERN"; name?: string; }; }; }; }; }
 Description
 The request specifying the required build parent keys, ref matcher and exemption matcher
- Readonlyresponses: { "200": { content: { "application/json": { buildParentKeys?: readonly string[]; exemptRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; id?: number; refMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { buildParentKeys?: readonly string[]; exemptRefMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; id?: number; refMatcher?: { displayId?: string; id?: string; type?: { id?: (...) | (...) | (...) | (...) | (...) | (...); name?: (...) | (...); }; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The details needed to update a required build merge check.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was malformed. This could be caused because:
 - The build parent key list is empty - Either of the provided ref matchers is of an unrecognized type - Either of the provided ref matchers could not be created with the provided type and id
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to create a required build merge check in this repository.
Optional Readonlytrace?: undefined

`Readonly/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/conditions`

"/required-builds/latest/projects/{projectKey}/repos/{repositorySlug}/conditions": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { limit?: number; start?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            buildParentKeys?: readonly (...)[];
                            exemptRefMatcher?: { displayId?: ...; id?: ...; type?: ... };
                            id?: number;
                            refMatcher?: { displayId?: ...; id?: ...; type?: ... };
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { buildParentKeys?: readonly (...)[]; exemptRefMatcher?: { displayId?: ...; id?: ...; type?: ... }; id?: number; refMatcher?: { displayId?: ...; id?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get required builds merge checks
Description
Returns a page of required build merge checks that have been configured for this repository.
The authenticated user must have **REPO_READ** permission for the target repository to request a page of required build merge checks.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { limit?: number; start?: number }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project that the repository belongs to
 - ReadonlyrepositorySlug: string
 Description
 The repository being used
 - Optional Readonlyquery?: { limit?: number; start?: number }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { buildParentKeys?: readonly (...)[]; exemptRefMatcher?: { displayId?: ...; id?: ...; type?: ... }; id?: number; refMatcher?: { displayId?: ...; id?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { buildParentKeys?: readonly (...)[]; exemptRefMatcher?: { displayId?: ...; id?: ...; type?: ... }; id?: number; refMatcher?: { displayId?: ...; id?: ...; type?: ... }; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The required build merge checks associated with the provided repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to request a page of required build merge checks in this repository.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/ssh/latest/keys`

"/ssh/latest/keys": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { user?: string; userName?: string };
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                limit?: number;
                start?: number;
                user?: string;
                userName?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        isLastPage?: boolean;
                        limit?: number;
                        nextPageStart?: number;
                        size?: number;
                        start?: number;
                        values?: readonly {
                            algorithmType?: string;
                            bitLength?: number;
                            createdDate?: string;
                            expiryDays?: number;
                            fingerprint?: string;
                            id?: number;
                            label?: string;
                            lastAuthenticated?: string;
                            text?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { user?: string };
        };
        requestBody?: {
            content: {
                "application/json": {
                    algorithmType?: string;
                    bitLength?: number;
                    createdDate?: string;
                    expiryDays?: number;
                    fingerprint?: string;
                    id?: number;
                    label?: string;
                    lastAuthenticated?: string;
                    text?: string;
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        algorithmType?: string;
                        bitLength?: number;
                        createdDate?: string;
                        expiryDays?: number;
                        fingerprint?: string;
                        id?: number;
                        label?: string;
                        lastAuthenticated?: string;
                        text?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { user?: string; userName?: string }; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Delete all user SSH key
Description
Delete all SSH keys for a supplied user.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { user?: string; userName?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { user?: string; userName?: string }
 - Optional Readonlyuser?: string
 - Optional ReadonlyuserName?: string
 Description
 the username of the user to delete the keys for. If no username is specified, the SSH keys will be deleted for the current authenticated user.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The SSH keys matching the supplied user were deleted.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the SSH keys. This is only possible when a user is explicitly supplied.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No user matches the supplied user
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number; user?: string; userName?: string; }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get SSH keys for user
Description
Retrieve a page of SSH keys.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { limit?: number; start?: number; user?: string; userName?: string; }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { limit?: number; start?: number; user?: string; userName?: string }
 - Optional Readonlylimit?: number
 Description
 Number of items to return. If not passed, a page size of 25 is used.
 Example
 25
 - Optional Readonlystart?: number
 Description
 Start number for the page (inclusive). If not passed, first page is assumed.
 Example
 0
 - Optional Readonlyuser?: string
 - Optional ReadonlyuserName?: string
 Description
 the username of the user to retrieve the keys for. If no username is specified, the SSH keys will be retrieved for the current authenticated user.
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 A page of SSH keys.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissionsto retrieve the SSH keys. This is only possible when auser is explicitly supplied.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No user matches the supplied user
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { user?: string }; }; requestBody?: { content: { "application/json": { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; }; }; responses: { "201": { content: { "application/json": { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Add SSH key for user
Description
Add a new SSH key to a supplied user.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { user?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Optional Readonlypath?: undefined
 - Optional Readonlyquery?: { user?: string }
 - Optional Readonlyuser?: string
 Description
 the username of the user to add the SSH key for. If no username is specified, the SSH key will be added for the current authenticated user.
- Optional ReadonlyrequestBody?: { content: { "application/json": { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; }; }
- Readonlyresponses: { "201": { content: { "application/json": { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly201: { content: { "application/json": { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The newly created SSH key.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The SSH key was not created because the key was not a valid RSA/DSA/ECDSA/Ed25519 key of a supported length.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Either there is no authenticated user or the currently authenticated user has insufficient permissions to add an SSH key. The latter is only possible when a user is explicitly supplied.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No user matches the supplied user
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The SSH key already exists on the system.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/ssh/latest/keys/{keyId}`

"/ssh/latest/keys/{keyId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { keyId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { keyId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        algorithmType?: string;
                        bitLength?: number;
                        createdDate?: string;
                        expiryDays?: number;
                        fingerprint?: string;
                        id?: number;
                        label?: string;
                        lastAuthenticated?: string;
                        text?: string;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Readonlydelete: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: string }; query?: undefined; }; requestBody?: undefined; responses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Remove SSH key
Description
Delete an SSH key.
The authenticated user must have ADMIN permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { keyId: string }
 - ReadonlykeyId: string
 Description
 the id of the key to delete.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "204": { content?: undefined; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The SSH key matching the supplied id was deleted or did not exist.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to delete the SSH key.
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { keyId: string }; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get SSH key for user by keyId
Description
Retrieve an SSH key by keyId
The authenticated user must have ADMIN permission or higher to call this resource.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { keyId: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { keyId: string }
 - ReadonlykeyId: string
 Description
 the ID of the key to retrieve.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { algorithmType?: string; bitLength?: number; createdDate?: string; expiryDays?: number; fingerprint?: string; id?: number; label?: string; lastAuthenticated?: string; text?: string; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 An SSH key.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissionsto retrieve the SSH key. This is only possible when akeyId is explicitly supplied.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 No SSH key matches the supplied keyId
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/ssh/latest/settings`

"/ssh/latest/settings": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        accessKeysEnabled?: boolean;
                        baseUrl?: string;
                        enabled?: boolean;
                        fingerprint?: { algorithm?: string; value?: string };
                        port?: number;
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { accessKeysEnabled?: boolean; baseUrl?: string; enabled?: boolean; fingerprint?: { algorithm?: string; value?: string }; port?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get SSH settings
Description
Gets the SSH settings from the upstream.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { accessKeysEnabled?: boolean; baseUrl?: string; enabled?: boolean; fingerprint?: { algorithm?: string; value?: string }; port?: number; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { accessKeysEnabled?: boolean; baseUrl?: string; enabled?: boolean; fingerprint?: { algorithm?: string; value?: string }; port?: number; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The ssh settings from upstream
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The request was not authenticated
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Optional Readonlypost?: undefined
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/sync/latest/projects/{projectKey}/repos/{repositorySlug}`

"/sync/latest/projects/{projectKey}/repos/{repositorySlug}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: { at?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        aheadRefs?: {
                            displayId?: string;
                            id?: string;
                            state?: "AHEAD"
                            | "DIVERGED"
                            | "ORPHANED";
                            tag?: boolean;
                            type?: "BRANCH" | "TAG";
                        };
                        available?: boolean;
                        divergedRefs?: {
                            displayId?: string;
                            id?: string;
                            state?: "AHEAD"
                            | "DIVERGED"
                            | "ORPHANED";
                            tag?: boolean;
                            type?: "BRANCH" | "TAG";
                        };
                        enabled?: boolean;
                        lastSync?: number;
                        orphanedRefs?: {
                            displayId?: string;
                            id?: string;
                            state?: "AHEAD"
                            | "DIVERGED"
                            | "ORPHANED";
                            tag?: boolean;
                            type?: "BRANCH" | "TAG";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    aheadRefs?: {
                        displayId?: string;
                        id?: string;
                        state?: "AHEAD"
                        | "DIVERGED"
                        | "ORPHANED";
                        tag?: boolean;
                        type?: "BRANCH" | "TAG";
                    };
                    available?: boolean;
                    divergedRefs?: {
                        displayId?: string;
                        id?: string;
                        state?: "AHEAD"
                        | "DIVERGED"
                        | "ORPHANED";
                        tag?: boolean;
                        type?: "BRANCH" | "TAG";
                    };
                    enabled?: boolean;
                    lastSync?: number;
                    orphanedRefs?: {
                        displayId?: string;
                        id?: string;
                        state?: "AHEAD"
                        | "DIVERGED"
                        | "ORPHANED";
                        tag?: boolean;
                        type?: "BRANCH" | "TAG";
                    };
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        aheadRefs?: {
                            displayId?: string;
                            id?: string;
                            state?: "AHEAD"
                            | "DIVERGED"
                            | "ORPHANED";
                            tag?: boolean;
                            type?: "BRANCH" | "TAG";
                        };
                        available?: boolean;
                        divergedRefs?: {
                            displayId?: string;
                            id?: string;
                            state?: "AHEAD"
                            | "DIVERGED"
                            | "ORPHANED";
                            tag?: boolean;
                            type?: "BRANCH" | "TAG";
                        };
                        enabled?: boolean;
                        lastSync?: number;
                        orphanedRefs?: {
                            displayId?: string;
                            id?: string;
                            state?: "AHEAD"
                            | "DIVERGED"
                            | "ORPHANED";
                            tag?: boolean;
                            type?: "BRANCH" | "TAG";
                        };
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Readonlyget: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string }; }; requestBody?: undefined; responses: { "200": { content: { "application/json": { aheadRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; available?: boolean; divergedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; enabled?: boolean; lastSync?: number; orphanedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Get synchronization status
Description
Retrieves the synchronization status for the specified repository. In addition to listing refs which cannot be synchronized, if any, the status also provides the timestamp for the most recent synchronization and indicates whether synchronization is available and enabled. If "?at" is specified in the URL, the synchronization status for the specified ref is returned, rather than the complete repository status.
The authenticated user must have REPO_READ permission for the repository, or it must be public if the request is anonymous. Additionally, after synchronization is enabled for a repository, meaning synchronization was available at that time, permission changes and other actions can cause it to become unavailable. Even when synchronization is enabled, if it is no longer available for the repository it will not be performed.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: { at?: string }; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: { at?: string }
 - Optional Readonlyat?: string
 Description
 Retrieves the synchronization status for the specified ref within the repository, rather than for the entire repository
- Optional ReadonlyrequestBody?: undefined
- Readonlyresponses: { "200": { content: { "application/json": { aheadRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; available?: boolean; divergedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; enabled?: boolean; lastSync?: number; orphanedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { aheadRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; available?: boolean; divergedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; enabled?: boolean; lastSync?: number; orphanedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Synchronization status for the specified repository, or specific ref within that repository.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to view the repository, or the repository is not public if the request is anonymous.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { aheadRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; available?: boolean; divergedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; enabled?: boolean; lastSync?: number; orphanedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; }; }; responses: { "200": { content: { "application/json": { aheadRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; available?: boolean; divergedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; enabled?: boolean; lastSync?: number; orphanedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Disable synchronization
Description
Enables or disables synchronization for the specified repository. When synchronization is enabled, branches within the repository are immediately synchronized and the status is updated with the outcome. That initial synchronization is performed before the REST request returns, allowing it to return the updated status.
The authenticated user must have REPO_ADMIN permission for the specified repository. Anonymous users cannot manage synchronization, even on public repositories. Additionally, synchronization must be available for the specified repository. Synchronization is only available if: - The repository is a fork, since its origin is used as upstream - The owning user still has access to the fork's origin, if the repository is a personalfork
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { aheadRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; available?: boolean; divergedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; enabled?: boolean; lastSync?: number; orphanedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { aheadRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; available?: boolean; divergedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; enabled?: boolean; lastSync?: number; orphanedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { aheadRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; available?: boolean; divergedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; enabled?: boolean; lastSync?: number; orphanedRefs?: { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The updated synchronization status for the repository, after enabling synchronization. 204 NO CONTENT is returned instead after disabling synchronization.
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 Synchronization has successfully been disabled. 200 OK, with updated status information, is returned instead after enabling synchronization.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The JSON payload for the request did not define the "enabled" property.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to manage synchronization in the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

`Readonly/sync/latest/projects/{projectKey}/repos/{repositorySlug}/synchronize`

"/sync/latest/projects/{projectKey}/repos/{repositorySlug}/synchronize": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { projectKey: string; repositorySlug: string };
            query?: undefined;
        };
        requestBody?: {
            content: {
                "application/json": {
                    action?: "DISCARD"
                    | "MERGE"
                    | "REBASE";
                    context?: { commitMessage?: string };
                    refId?: string;
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        displayId?: string;
                        id?: string;
                        state?: "AHEAD"
                        | "DIVERGED"
                        | "ORPHANED";
                        tag?: boolean;
                        type?: "BRANCH" | "TAG";
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "204": {
                content?: undefined;
                headers: Readonly<Record<string, unknown>>;
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "401": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "409": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
            "501": {
                content: {
                    "application/json": {
                        errors?: readonly {
                            context?: string;
                            exceptionName?: string;
                            message?: string;
                        }[];
                    };
                };
                headers: Readonly<Record<string, unknown>>;
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

`Type declaration`

Optional Readonlydelete?: undefined
Optional Readonlyget?: undefined
Optional Readonlyhead?: undefined
Optional Readonlyoptions?: undefined
Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optional Readonlypatch?: undefined
Readonlypost: { parameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }; requestBody?: { content: { "application/json": { action?: "DISCARD" | "MERGE" | "REBASE"; context?: { commitMessage?: string }; refId?: string; }; }; }; responses: { "200": { content: { "application/json": { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "501": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }; }
Manual synchronization
Description
Allows developers to apply a manual operation to bring a ref back in sync with upstream when it becomes out of sync due to conflicting changes. The following actions are supported:
- <tt>MERGE</tt>: Merges in commits from the upstream ref. After applying this action, the synchronized ref will be <tt>AHEAD</tt> (as it still includes commits that do not exist upstream. - This action is only supported for <tt>DIVERGED</tt> refs - If a "commitMessage" is provided in the context, it will be used on the merge commit. Otherwise a default message is used. - <tt>DISCARD</tt>: Throws away local changes in favour of those made upstream. This is a destructive operation where commits in the local repository are lost. - No context entries are supported for this action - If the upstream ref has been deleted, the local ref is deleted as well - Otherwise, the local ref is updated to reference the same commit as upstream, even if the update is not fast-forward (similar to a forced push) The authenticated user must have REPO_WRITE permission for the specified repository. Anonymous users cannot synchronize refs, even on public repositories. Additionally, synchronization must be enabled and available for the specified repository.
- Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; repositorySlug: string }; query?: undefined; }
 - Optional Readonlycookie?: undefined
 - Optional Readonlyheader?: undefined
 - Readonlypath: { projectKey: string; repositorySlug: string }
 - ReadonlyprojectKey: string
 Description
 The project key.
 - ReadonlyrepositorySlug: string
 Description
 The repository slug.
 - Optional Readonlyquery?: undefined
- Optional ReadonlyrequestBody?: { content: { "application/json": { action?: "DISCARD" | "MERGE" | "REBASE"; context?: { commitMessage?: string }; refId?: string; }; }; }
- Readonlyresponses: { "200": { content: { "application/json": { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }; "204": { content?: undefined; headers: Readonly<Record<string, unknown>> }; "400": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "401": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "404": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "409": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; "501": { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }; }
 - Readonly200: { content: { "application/json": { displayId?: string; id?: string; state?: "AHEAD" | "DIVERGED" | "ORPHANED"; tag?: boolean; type?: "BRANCH" | "TAG"; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested action was successfully performed, and has updated the ref's state, but the ref if is still not in sync with upstream. For example, after applying the MERGE action, the ref will still be AHEAD of upstream. If the action brings the ref in sync with upstream, 204 NO CONTENT is returned instead.
 - Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }
 Description
 The requested action was successfully performed and the ref is now in sync with upstream. If the action updates the ref but does not bring it in sync with upstream, 200 OK is returned instead.
 - Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested synchronization action was not understood.
 - Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The currently authenticated user has insufficient permissions to update refs within the specified repository.
 - Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The specified repository does not exist.
 - Readonly409: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 Synchronization is not available or enabled for the specified repository, or the ref is already in sync with upstream.
 - Readonly501: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>; }
 Description
 The requested synchronization action was understood by the server, but the mechanism to apply it has not been implemented.
Optional Readonlyput?: undefined
Optional Readonlytrace?: undefined

Interface paths

Index

Properties

Properties

Readonly/access-tokens/latest/projects/{projectKey}

Type declaration

Optional Readonlydelete?: undefined

Description

Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: { limit?: number; start?: number };}

Optional Readonlycookie?: undefined

Optional Readonlyheader?: undefined

Readonlypath: { projectKey: string }

ReadonlyprojectKey: string

Description

Optional Readonlyquery?: { limit?: number; start?: number }

Optional Readonlylimit?: number

Description

Example

Optional Readonlystart?: number

Description

Example

Optional ReadonlyrequestBody?: undefined

Readonly200: { content: { "application/json": { isLastPage?: boolean; limit?: number; nextPageStart?: number; size?: number; start?: number; values?: readonly { createdDate?: string; id?: string; name?: string }[]; }; }; headers: Readonly<Record<string, unknown>>;}

Description

Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>;}

Description

Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>;}

Description

Optional Readonlyhead?: undefined

Optional Readonlyoptions?: undefined

Readonlyparameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }

Optional Readonlypatch?: undefined

Optional Readonlypost?: undefined

Description

Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string }; query?: undefined;}

Optional Readonlycookie?: undefined

Optional Readonlyheader?: undefined

Readonlypath: { projectKey: string }

ReadonlyprojectKey: string

Description

Optional Readonlyquery?: undefined

Optional ReadonlyrequestBody?: { content: { "application/json": { expiryDays?: number; name?: string; permissions?: readonly string[]; }; };}

Description

Readonly200: { content: { "application/json": { createdDate?: string; id?: string; name?: string; token?: string; }; }; headers: Readonly<Record<string, unknown>>;}

Description

Readonly400: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>;}

Description

Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>;}

Description

Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>;}

Description

Optional Readonlytrace?: undefined

Readonly/access-tokens/latest/projects/{projectKey}/{tokenId}

Type declaration

Description

Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; tokenId: string }; query?: undefined;}

Optional Readonlycookie?: undefined

Optional Readonlyheader?: undefined

Readonlypath: { projectKey: string; tokenId: string }

ReadonlyprojectKey: string

Description

ReadonlytokenId: string

Description

Optional Readonlyquery?: undefined

Optional ReadonlyrequestBody?: undefined

Readonly204: { content?: undefined; headers: Readonly<Record<string, unknown>> }

Description

Readonly401: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>;}

Description

Readonly404: { content: { "application/json": { errors?: readonly { context?: string; exceptionName?: string; message?: string; }[]; }; }; headers: Readonly<Record<string, unknown>>;}

Description

Description

Readonlyparameters: { cookie?: undefined; header?: undefined; path: { projectKey: string; tokenId: string }; query?: undefined;}

Optional Readonlycookie?: undefined

Optional Readonlyheader?: undefined

Readonlypath: { projectKey: string; tokenId: string }

ReadonlyprojectKey: string

Description

ReadonlytokenId: string

Description

`Readonly`/access-tokens/latest/projects/{projectKey}

`Optional` `Readonly`delete?: undefined

`Readonly`parameters: {
cookie?: undefined;
header?: undefined;
path: { projectKey: string };
query?: { limit?: number; start?: number };
}

`Optional` `Readonly`cookie?: undefined

`Optional` `Readonly`header?: undefined

`Readonly`path: { projectKey: string }

`Readonly`projectKey: string

`Optional` `Readonly`query?: { limit?: number; start?: number }

`Optional` `Readonly`limit?: number

`Optional` `Readonly`start?: number

`Optional` `Readonly`requestBody?: undefined

`Readonly`200: {
content: {
"application/json": {
isLastPage?: boolean;
limit?: number;
nextPageStart?: number;
size?: number;
start?: number;
values?: readonly { createdDate?: string; id?: string; name?: string }[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`401: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`404: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Optional` `Readonly`head?: undefined

`Optional` `Readonly`options?: undefined

`Readonly`parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }

`Optional` `Readonly`patch?: undefined

`Optional` `Readonly`post?: undefined

`Readonly`parameters: {
cookie?: undefined;
header?: undefined;
path: { projectKey: string };
query?: undefined;
}

`Optional` `Readonly`cookie?: undefined

`Optional` `Readonly`header?: undefined

`Readonly`path: { projectKey: string }

`Readonly`projectKey: string

`Optional` `Readonly`query?: undefined

`Optional` `Readonly`requestBody?: {
content: {
"application/json": {
expiryDays?: number;
name?: string;
permissions?: readonly string[];
};
};
}

`Readonly`200: {
content: {
"application/json": {
createdDate?: string;
id?: string;
name?: string;
token?: string;
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`400: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`401: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`404: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Optional` `Readonly`trace?: undefined

`Readonly`/access-tokens/latest/projects/{projectKey}/{tokenId}

`Readonly`parameters: {
cookie?: undefined;
header?: undefined;
path: { projectKey: string; tokenId: string };
query?: undefined;
}

`Optional` `Readonly`cookie?: undefined

`Optional` `Readonly`header?: undefined

`Readonly`path: { projectKey: string; tokenId: string }

`Readonly`projectKey: string

`Readonly`tokenId: string

`Optional` `Readonly`query?: undefined

`Optional` `Readonly`requestBody?: undefined

`Readonly`204: { content?: undefined; headers: Readonly<Record<string, unknown>> }

`Readonly`401: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`404: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`parameters: {
cookie?: undefined;
header?: undefined;
path: { projectKey: string; tokenId: string };
query?: undefined;
}

`Optional` `Readonly`cookie?: undefined

`Optional` `Readonly`header?: undefined

`Readonly`path: { projectKey: string; tokenId: string }

`Readonly`projectKey: string

`Readonly`tokenId: string

`Optional` `Readonly`query?: undefined

`Optional` `Readonly`requestBody?: undefined

`Readonly`200: {
content: {
"application/json": {
createdDate?: string;
id?: string;
name?: string;
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`401: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`404: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Optional` `Readonly`head?: undefined

`Optional` `Readonly`options?: undefined

`Readonly`parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }

`Optional` `Readonly`patch?: undefined

`Readonly`parameters: {
cookie?: undefined;
header?: undefined;
path: { projectKey: string; tokenId: string };
query?: undefined;
}

`Optional` `Readonly`cookie?: undefined

`Optional` `Readonly`header?: undefined

`Readonly`path: { projectKey: string; tokenId: string }

`Readonly`projectKey: string

`Readonly`tokenId: string

`Optional` `Readonly`query?: undefined

`Optional` `Readonly`requestBody?: {
content: {
"application/json": {
expiryDays?: number;
name?: string;
permissions?: readonly string[];
};
};
}

`Readonly`200: {
content: {
"application/json": {
createdDate?: string;
id?: string;
name?: string;
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`400: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Readonly`401: {
content: {
"application/json": {
errors?: readonly {
context?: string;
exceptionName?: string;
message?: string;
}[];
};
};
headers: Readonly<Record<string, unknown>>;
}

`Optional` `Readonly`put?: undefined

`Optional` `Readonly`trace?: undefined

`Readonly`/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}

`Optional` `Readonly`delete?: undefined

`Readonly`parameters: {
cookie?: undefined;
header?: undefined;
path: { projectKey: string; repositorySlug: string };
query?: { limit?: number; start?: number };
}

`Optional` `Readonly`cookie?: undefined

`Optional` `Readonly`header?: undefined

`Readonly`path: { projectKey: string; repositorySlug: string }

`Readonly`projectKey: string

`Readonly`repositorySlug: string

`Optional` `Readonly`query?: { limit?: number; start?: number }