From eff4eca2542f5c58a970275902b2ed9931d35155 Mon Sep 17 00:00:00 2001 From: Sam Lucidi Date: Fri, 12 Jul 2024 14:18:29 -0400 Subject: [PATCH] Update documentation for 0.5.0 Signed-off-by: Sam Lucidi --- Makefile | 2 +- api/analysis.go | 2 +- api/file.go | 2 +- docs/docs.go | 1343 ++++++++++++++++++++- docs/index.html | 2828 ++++++++++++++++++++++---------------------- docs/openapi3.json | 1396 +++++++++++++++++++++- docs/swagger.json | 1338 ++++++++++++++++++++- docs/swagger.yaml | 1333 ++++++++++++++++++++- 8 files changed, 6635 insertions(+), 1609 deletions(-) diff --git a/Makefile b/Makefile index 0de4b1910..cc27ae466 100644 --- a/Makefile +++ b/Makefile @@ -94,7 +94,7 @@ docs: docs-html docs-openapi3 docs-binding # Build Swagger API spec into ./docs directory docs-swagger: - $(GOBIN)/swag init -g pkg.go --dir api,assessment + $(GOBIN)/swag init --parseDependency --parseInternal --parseDepth 1 -g pkg.go --dir api,assessment # Build OpenAPI 3.0 docs docs-openapi3: docs-swagger diff --git a/api/analysis.go b/api/analysis.go index 977e89131..547040f52 100644 --- a/api/analysis.go +++ b/api/analysis.go @@ -216,7 +216,7 @@ func (h AnalysisHandler) AppLatest(ctx *gin.Context) { // @description Archive an analysis (report) by ID. // @tags analyses // @produce octet-stream -// @success 204 {object} +// @success 204 // @router /analyses/{id}/archive [post] // @param id path int true "Analysis ID" func (h AnalysisHandler) Archive(ctx *gin.Context) { diff --git a/api/file.go b/api/file.go index 827cc8a68..5e280172f 100644 --- a/api/file.go +++ b/api/file.go @@ -129,7 +129,7 @@ func (h FileHandler) Create(ctx *gin.Context) { // @produce json // @success 204 // @router /files/{id} [put] -// @param name id uint true "File ID" +// @param id path uint true "File ID" func (h FileHandler) Append(ctx *gin.Context) { var err error input, err := ctx.FormFile(FileField) diff --git a/docs/docs.go b/docs/docs.go index 2318e3e2f..dba9ad23e 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1,5 +1,4 @@ -// Package docs GENERATED BY SWAG; DO NOT EDIT -// This file was generated by swaggo/swag +// Package docs Code generated by swaggo/swag. DO NOT EDIT package docs import "github.com/swaggo/swag" @@ -161,6 +160,58 @@ const docTemplate = `{ } } }, + "/analyses/incidents": { + "get": { + "description": "List all incidents.\nfilters:\n- file\n- issue.id", + "produces": [ + "application/json" + ], + "tags": [ + "incidents" + ], + "summary": "List all incidents.", + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/api.Incident" + } + } + } + } + } + }, + "/analyses/incidents/{id}": { + "get": { + "description": "Get an incident.", + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Get an incident.", + "parameters": [ + { + "type": "integer", + "description": "Issue ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/api.Incident" + } + } + } + } + }, "/analyses/issues": { "get": { "description": "List all issues.\nfilters:\n- ruleset\n- rule\n- name\n- category\n- effort\n- labels\n- application.id\n- application.name\n- tag.id", @@ -405,6 +456,96 @@ const docTemplate = `{ } } }, + "/analyses/{id}/archive": { + "post": { + "description": "Archive an analysis (report) by ID.", + "produces": [ + "application/octet-stream" + ], + "tags": [ + "analyses" + ], + "summary": "Archive an analysis (report) by ID.", + "parameters": [ + { + "type": "integer", + "description": "Analysis ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/analyses/{id}/dependencies": { + "get": { + "description": "List analysis dependencies.\nfilters:\n- name\n- version\n- sha\n- indirect\n- labels", + "produces": [ + "application/json" + ], + "tags": [ + "dependencies" + ], + "summary": "List analysis dependencies.", + "parameters": [ + { + "type": "integer", + "description": "Analysis ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/api.TechDependency" + } + } + } + } + } + }, + "/analyses/{id}/issues": { + "get": { + "description": "List issues for an analysis.\nfilters:\n- ruleset\n- rule\n- name\n- category\n- effort\n- labels", + "produces": [ + "application/json" + ], + "tags": [ + "issues" + ], + "summary": "List issues for an analysis.", + "parameters": [ + { + "type": "integer", + "description": "Analysis ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/api.Issue" + } + } + } + } + } + }, "/application/{id}/analyses": { "post": { "description": "Create an analysis.\nForm fields:\n- file: file that contains the api.Analysis resource.\n- issues: file that multiple api.Issue resources.\n- dependencies: file that multiple api.TechDependency resources.", @@ -2281,6 +2422,33 @@ const docTemplate = `{ } } }, + "put": { + "description": "Append a file.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "file" + ], + "summary": "Append a file.", + "parameters": [ + { + "type": "integer", + "description": "File ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + }, "delete": { "description": "Delete a file.", "tags": [ @@ -4671,7 +4839,7 @@ const docTemplate = `{ }, "/taskgroups/{id}/submit": { "put": { - "description": "Submit a task group.", + "description": "Patch and submit a task group.", "consumes": [ "application/json" ], @@ -4705,21 +4873,21 @@ const docTemplate = `{ }, "/tasks": { "get": { - "description": "List all tasks.", + "description": "Queued queued task report.\nFilters:\n- addon", "produces": [ "application/json" ], "tags": [ "tasks" ], - "summary": "List all tasks.", + "summary": "Queued queued task report.", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { - "$ref": "#/definitions/api.Task" + "$ref": "#/definitions/api.TaskQueue" } } } @@ -4814,8 +4982,8 @@ const docTemplate = `{ } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK" } } }, @@ -4841,6 +5009,32 @@ const docTemplate = `{ } } }, + "/tasks/{id}/attached": { + "get": { + "description": "Get attached files.\nReturns a tarball with attached files.", + "produces": [ + "application/octet-stream" + ], + "tags": [ + "tasks" + ], + "summary": "Get attached files.", + "parameters": [ + { + "type": "integer", + "description": "Task ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, "/tasks/{id}/bucket/{wildcard}": { "get": { "description": "Get bucket content by ID and path.\nReturns index.html for directories when Accept=text/html else a tarball.\n?filter=glob supports directory content filtering.", @@ -4959,8 +5153,8 @@ const docTemplate = `{ } ], "responses": { - "204": { - "description": "No Content" + "202": { + "description": "Accepted" } } } @@ -4997,11 +5191,8 @@ const docTemplate = `{ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/api.TaskReport" - } + "204": { + "description": "No Content" } } }, @@ -5074,7 +5265,7 @@ const docTemplate = `{ }, "/tasks/{id}/submit": { "put": { - "description": "Submit a task.", + "description": "Patch and submit a task.", "consumes": [ "application/json" ], @@ -5100,8 +5291,8 @@ const docTemplate = `{ } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK" } } } @@ -5461,9 +5652,16 @@ const docTemplate = `{ "api.Addon": { "type": "object", "properties": { - "image": { - "type": "string" + "container": { + "$ref": "#/definitions/v1.Container" + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/api.Extension" + } }, + "metadata": {}, "name": { "type": "string" } @@ -5472,9 +5670,15 @@ const docTemplate = `{ "api.Analysis": { "type": "object", "properties": { + "application": { + "$ref": "#/definitions/api.Ref" + }, "archived": { "type": "boolean" }, + "commit": { + "type": "string" + }, "createTime": { "type": "string" }, @@ -5700,6 +5904,9 @@ const docTemplate = `{ "questionnaire": { "$ref": "#/definitions/api.Ref" }, + "required": { + "type": "boolean" + }, "risk": { "description": "read only", "type": "string" @@ -5736,6 +5943,23 @@ const docTemplate = `{ } } }, + "api.Attachment": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "activity": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + }, "api.Bucket": { "type": "object", "properties": { @@ -5892,6 +6116,27 @@ const docTemplate = `{ } } }, + "api.Extension": { + "type": "object", + "properties": { + "addon": { + "type": "string" + }, + "capabilities": { + "type": "array", + "items": { + "type": "string" + } + }, + "container": { + "$ref": "#/definitions/v1.Container" + }, + "metadata": {}, + "name": { + "type": "string" + } + } + }, "api.Fact": { "type": "object", "properties": { @@ -5906,11 +6151,11 @@ const docTemplate = `{ }, "api.FactMap": { "type": "object", - "additionalProperties": true + "additionalProperties": {} }, "api.Fields": { "type": "object", - "additionalProperties": true + "additionalProperties": {} }, "api.File": { "type": "object", @@ -5999,7 +6244,7 @@ const docTemplate = `{ }, "api.Import": { "type": "object", - "additionalProperties": true + "additionalProperties": {} }, "api.ImportSummary": { "type": "object", @@ -6057,6 +6302,9 @@ const docTemplate = `{ "id": { "type": "integer" }, + "issue": { + "type": "integer" + }, "line": { "type": "integer" }, @@ -6077,6 +6325,9 @@ const docTemplate = `{ "ruleset" ], "properties": { + "analysis": { + "type": "integer" + }, "category": { "type": "string" }, @@ -6301,6 +6552,10 @@ const docTemplate = `{ }, "api.MigrationWave": { "type": "object", + "required": [ + "endDate", + "startDate" + ], "properties": { "applications": { "type": "array", @@ -6431,6 +6686,7 @@ const docTemplate = `{ }, "sections": { "type": "array", + "minItems": 1, "items": { "$ref": "#/definitions/assessment.Section" } @@ -6776,9 +7032,6 @@ const docTemplate = `{ "pending": { "type": "integer" }, - "postponed": { - "type": "integer" - }, "running": { "type": "integer" }, @@ -6918,10 +7171,6 @@ const docTemplate = `{ }, "api.Task": { "type": "object", - "required": [ - "addon", - "data" - ], "properties": { "activity": { "type": "array", @@ -6935,31 +7184,44 @@ const docTemplate = `{ "application": { "$ref": "#/definitions/api.Ref" }, + "attached": { + "type": "array", + "items": { + "$ref": "#/definitions/api.Attachment" + } + }, "bucket": { "$ref": "#/definitions/api.Ref" }, - "canceled": { - "type": "boolean" - }, "createTime": { "type": "string" }, "createUser": { "type": "string" }, - "data": { - "type": "object" - }, + "data": {}, "errors": { "type": "array", "items": { "$ref": "#/definitions/api.TaskError" } }, + "events": { + "type": "array", + "items": { + "$ref": "#/definitions/api.TaskEvent" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + } + }, "id": { "type": "integer" }, - "image": { + "kind": { "type": "string" }, "locator": { @@ -6972,14 +7234,11 @@ const docTemplate = `{ "type": "string" }, "policy": { - "type": "string" + "$ref": "#/definitions/api.TaskPolicy" }, "priority": { "type": "integer" }, - "purged": { - "type": "boolean" - }, "retries": { "type": "integer" }, @@ -6997,9 +7256,6 @@ const docTemplate = `{ }, "updateUser": { "type": "string" - }, - "variant": { - "type": "string" } } }, @@ -7014,6 +7270,23 @@ const docTemplate = `{ } } }, + "api.TaskEvent": { + "type": "object", + "properties": { + "count": { + "type": "integer" + }, + "kind": { + "type": "string" + }, + "last": { + "type": "string" + }, + "reason": { + "type": "string" + } + } + }, "api.TaskGroup": { "type": "object", "required": [ @@ -7035,12 +7308,27 @@ const docTemplate = `{ "data": { "type": "object" }, + "extensions": { + "type": "array", + "items": { + "type": "string" + } + }, "id": { "type": "integer" }, + "kind": { + "type": "string" + }, "name": { "type": "string" }, + "policy": { + "$ref": "#/definitions/api.TaskPolicy" + }, + "priority": { + "type": "integer" + }, "state": { "type": "string" }, @@ -7055,6 +7343,40 @@ const docTemplate = `{ } } }, + "api.TaskPolicy": { + "type": "object", + "properties": { + "isolated": { + "type": "boolean" + }, + "preemptEnabled": { + "type": "boolean" + }, + "preemptExempt": { + "type": "boolean" + } + } + }, + "api.TaskQueue": { + "type": "object", + "properties": { + "pending": { + "type": "integer" + }, + "postponed": { + "type": "integer" + }, + "ready": { + "type": "integer" + }, + "running": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, "api.TaskReport": { "type": "object", "properties": { @@ -7064,6 +7386,12 @@ const docTemplate = `{ "type": "string" } }, + "attached": { + "type": "array", + "items": { + "$ref": "#/definitions/api.Attachment" + } + }, "completed": { "type": "integer" }, @@ -7082,9 +7410,7 @@ const docTemplate = `{ "id": { "type": "integer" }, - "result": { - "type": "object" - }, + "result": {}, "status": { "type": "string" }, @@ -7105,6 +7431,9 @@ const docTemplate = `{ "name" ], "properties": { + "analysis": { + "type": "integer" + }, "createTime": { "type": "string" }, @@ -7306,7 +7635,10 @@ const docTemplate = `{ "risk": { "type": "string", "enum": [ - "red" + "red", + "yellow", + "green", + "unknown" ] }, "selected": { @@ -7336,6 +7668,7 @@ const docTemplate = `{ "properties": { "answers": { "type": "array", + "minItems": 1, "items": { "$ref": "#/definitions/assessment.Answer" } @@ -7397,6 +7730,7 @@ const docTemplate = `{ }, "questions": { "type": "array", + "minItems": 1, "items": { "$ref": "#/definitions/assessment.Question" } @@ -7416,6 +7750,917 @@ const docTemplate = `{ "type": "integer" } } + }, + "intstr.IntOrString": { + "type": "object", + "properties": { + "intVal": { + "type": "integer" + }, + "strVal": { + "type": "string" + }, + "type": { + "$ref": "#/definitions/intstr.Type" + } + } + }, + "intstr.Type": { + "type": "integer", + "enum": [ + 0, + 1 + ], + "x-enum-comments": { + "Int": "The IntOrString holds an int.", + "String": "The IntOrString holds a string." + }, + "x-enum-varnames": [ + "Int", + "String" + ] + }, + "resource.Quantity": { + "type": "object", + "properties": { + "Format": { + "type": "string", + "enum": [ + "DecimalExponent", + "BinarySI", + "DecimalSI" + ], + "x-enum-comments": { + "BinarySI": "e.g., 12Mi (12 * 2^20)", + "DecimalExponent": "e.g., 12e6", + "DecimalSI": "e.g., 12M (12 * 10^6)" + }, + "x-enum-varnames": [ + "DecimalExponent", + "BinarySI", + "DecimalSI" + ] + } + } + }, + "v1.Capabilities": { + "type": "object", + "properties": { + "add": { + "description": "Added capabilities\n+optional", + "type": "array", + "items": { + "type": "string" + } + }, + "drop": { + "description": "Removed capabilities\n+optional", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "v1.ConfigMapEnvSource": { + "type": "object", + "properties": { + "name": { + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", + "type": "string" + }, + "optional": { + "description": "Specify whether the ConfigMap must be defined\n+optional", + "type": "boolean" + } + } + }, + "v1.ConfigMapKeySelector": { + "type": "object", + "properties": { + "key": { + "description": "The key to select.", + "type": "string" + }, + "name": { + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", + "type": "string" + }, + "optional": { + "description": "Specify whether the ConfigMap or its key must be defined\n+optional", + "type": "boolean" + } + } + }, + "v1.Container": { + "type": "object", + "properties": { + "args": { + "description": "Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", + "type": "array", + "items": { + "type": "string" + } + }, + "command": { + "description": "Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", + "type": "array", + "items": { + "type": "string" + } + }, + "env": { + "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge", + "type": "array", + "items": { + "$ref": "#/definitions/v1.EnvVar" + } + }, + "envFrom": { + "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional", + "type": "array", + "items": { + "$ref": "#/definitions/v1.EnvFromSource" + } + }, + "image": { + "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional", + "type": "string" + }, + "imagePullPolicy": { + "description": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.PullPolicy" + } + ] + }, + "lifecycle": { + "description": "Actions that the management system should take in response to container lifecycle events.\nCannot be updated.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.Lifecycle" + } + ] + }, + "livenessProbe": { + "description": "Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.Probe" + } + ] + }, + "name": { + "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated.", + "type": "string" + }, + "ports": { + "description": "List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol", + "type": "array", + "items": { + "$ref": "#/definitions/v1.ContainerPort" + } + }, + "readinessProbe": { + "description": "Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.Probe" + } + ] + }, + "resources": { + "description": "Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.ResourceRequirements" + } + ] + }, + "securityContext": { + "description": "SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.SecurityContext" + } + ] + }, + "startupProbe": { + "description": "StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.Probe" + } + ] + }, + "stdin": { + "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional", + "type": "boolean" + }, + "stdinOnce": { + "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional", + "type": "boolean" + }, + "terminationMessagePath": { + "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional", + "type": "string" + }, + "terminationMessagePolicy": { + "description": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.TerminationMessagePolicy" + } + ] + }, + "tty": { + "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional", + "type": "boolean" + }, + "volumeDevices": { + "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional", + "type": "array", + "items": { + "$ref": "#/definitions/v1.VolumeDevice" + } + }, + "volumeMounts": { + "description": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge", + "type": "array", + "items": { + "$ref": "#/definitions/v1.VolumeMount" + } + }, + "workingDir": { + "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional", + "type": "string" + } + } + }, + "v1.ContainerPort": { + "type": "object", + "properties": { + "containerPort": { + "description": "Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 \u003c x \u003c 65536.", + "type": "integer" + }, + "hostIP": { + "description": "What host IP to bind the external port to.\n+optional", + "type": "string" + }, + "hostPort": { + "description": "Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 \u003c x \u003c 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this.\n+optional", + "type": "integer" + }, + "name": { + "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.\n+optional", + "type": "string" + }, + "protocol": { + "description": "Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\".\n+optional\n+default=\"TCP\"", + "allOf": [ + { + "$ref": "#/definitions/v1.Protocol" + } + ] + } + } + }, + "v1.EnvFromSource": { + "type": "object", + "properties": { + "configMapRef": { + "description": "The ConfigMap to select from\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.ConfigMapEnvSource" + } + ] + }, + "prefix": { + "description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.\n+optional", + "type": "string" + }, + "secretRef": { + "description": "The Secret to select from\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.SecretEnvSource" + } + ] + } + } + }, + "v1.EnvVar": { + "type": "object", + "properties": { + "name": { + "description": "Name of the environment variable. Must be a C_IDENTIFIER.", + "type": "string" + }, + "value": { + "description": "Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".\n+optional", + "type": "string" + }, + "valueFrom": { + "description": "Source for the environment variable's value. Cannot be used if value is not empty.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.EnvVarSource" + } + ] + } + } + }, + "v1.EnvVarSource": { + "type": "object", + "properties": { + "configMapKeyRef": { + "description": "Selects a key of a ConfigMap.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.ConfigMapKeySelector" + } + ] + }, + "fieldRef": { + "description": "Selects a field of the pod: supports metadata.name, metadata.namespace, ` + "`" + `metadata.labels['\u003cKEY\u003e']` + "`" + `, ` + "`" + `metadata.annotations['\u003cKEY\u003e']` + "`" + `,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.ObjectFieldSelector" + } + ] + }, + "resourceFieldRef": { + "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.ResourceFieldSelector" + } + ] + }, + "secretKeyRef": { + "description": "Selects a key of a secret in the pod's namespace\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.SecretKeySelector" + } + ] + } + } + }, + "v1.ExecAction": { + "type": "object", + "properties": { + "command": { + "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\n+optional", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "v1.GRPCAction": { + "type": "object", + "properties": { + "port": { + "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", + "type": "integer" + }, + "service": { + "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.\n+optional\n+default=\"\"", + "type": "string" + } + } + }, + "v1.HTTPGetAction": { + "type": "object", + "properties": { + "host": { + "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.\n+optional", + "type": "string" + }, + "httpHeaders": { + "description": "Custom headers to set in the request. HTTP allows repeated headers.\n+optional", + "type": "array", + "items": { + "$ref": "#/definitions/v1.HTTPHeader" + } + }, + "path": { + "description": "Path to access on the HTTP server.\n+optional", + "type": "string" + }, + "port": { + "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", + "allOf": [ + { + "$ref": "#/definitions/intstr.IntOrString" + } + ] + }, + "scheme": { + "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.URIScheme" + } + ] + } + } + }, + "v1.HTTPHeader": { + "type": "object", + "properties": { + "name": { + "description": "The header field name", + "type": "string" + }, + "value": { + "description": "The header field value", + "type": "string" + } + } + }, + "v1.Lifecycle": { + "type": "object", + "properties": { + "postStart": { + "description": "PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.LifecycleHandler" + } + ] + }, + "preStop": { + "description": "PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.LifecycleHandler" + } + ] + } + } + }, + "v1.LifecycleHandler": { + "type": "object", + "properties": { + "exec": { + "description": "Exec specifies the action to take.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.ExecAction" + } + ] + }, + "httpGet": { + "description": "HTTPGet specifies the http request to perform.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.HTTPGetAction" + } + ] + }, + "tcpSocket": { + "description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.TCPSocketAction" + } + ] + } + } + }, + "v1.MountPropagationMode": { + "type": "string", + "enum": [ + "None", + "HostToContainer", + "Bidirectional" + ], + "x-enum-varnames": [ + "MountPropagationNone", + "MountPropagationHostToContainer", + "MountPropagationBidirectional" + ] + }, + "v1.ObjectFieldSelector": { + "type": "object", + "properties": { + "apiVersion": { + "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".\n+optional", + "type": "string" + }, + "fieldPath": { + "description": "Path of the field to select in the specified API version.", + "type": "string" + } + } + }, + "v1.Probe": { + "type": "object", + "properties": { + "exec": { + "description": "Exec specifies the action to take.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.ExecAction" + } + ] + }, + "failureThreshold": { + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.\n+optional", + "type": "integer" + }, + "grpc": { + "description": "GRPC specifies an action involving a GRPC port.\nThis is a beta field and requires enabling GRPCContainerProbe feature gate.\n+featureGate=GRPCContainerProbe\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.GRPCAction" + } + ] + }, + "httpGet": { + "description": "HTTPGet specifies the http request to perform.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.HTTPGetAction" + } + ] + }, + "initialDelaySeconds": { + "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", + "type": "integer" + }, + "periodSeconds": { + "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.\n+optional", + "type": "integer" + }, + "successThreshold": { + "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.\n+optional", + "type": "integer" + }, + "tcpSocket": { + "description": "TCPSocket specifies an action involving a TCP port.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.TCPSocketAction" + } + ] + }, + "terminationGracePeriodSeconds": { + "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\n+optional", + "type": "integer" + }, + "timeoutSeconds": { + "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", + "type": "integer" + } + } + }, + "v1.ProcMountType": { + "type": "string", + "enum": [ + "Default", + "Unmasked" + ], + "x-enum-varnames": [ + "DefaultProcMount", + "UnmaskedProcMount" + ] + }, + "v1.Protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP", + "SCTP" + ], + "x-enum-varnames": [ + "ProtocolTCP", + "ProtocolUDP", + "ProtocolSCTP" + ] + }, + "v1.PullPolicy": { + "type": "string", + "enum": [ + "Always", + "Never", + "IfNotPresent" + ], + "x-enum-varnames": [ + "PullAlways", + "PullNever", + "PullIfNotPresent" + ] + }, + "v1.ResourceFieldSelector": { + "type": "object", + "properties": { + "containerName": { + "description": "Container name: required for volumes, optional for env vars\n+optional", + "type": "string" + }, + "divisor": { + "description": "Specifies the output format of the exposed resources, defaults to \"1\"\n+optional", + "allOf": [ + { + "$ref": "#/definitions/resource.Quantity" + } + ] + }, + "resource": { + "description": "Required: resource to select", + "type": "string" + } + } + }, + "v1.ResourceList": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/resource.Quantity" + } + }, + "v1.ResourceRequirements": { + "type": "object", + "properties": { + "limits": { + "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.ResourceList" + } + ] + }, + "requests": { + "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.ResourceList" + } + ] + } + } + }, + "v1.SELinuxOptions": { + "type": "object", + "properties": { + "level": { + "description": "Level is SELinux level label that applies to the container.\n+optional", + "type": "string" + }, + "role": { + "description": "Role is a SELinux role label that applies to the container.\n+optional", + "type": "string" + }, + "type": { + "description": "Type is a SELinux type label that applies to the container.\n+optional", + "type": "string" + }, + "user": { + "description": "User is a SELinux user label that applies to the container.\n+optional", + "type": "string" + } + } + }, + "v1.SeccompProfile": { + "type": "object", + "properties": { + "localhostProfile": { + "description": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust only be set if type is \"Localhost\".\n+optional", + "type": "string" + }, + "type": { + "description": "type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.\n+unionDiscriminator", + "allOf": [ + { + "$ref": "#/definitions/v1.SeccompProfileType" + } + ] + } + } + }, + "v1.SeccompProfileType": { + "type": "string", + "enum": [ + "Unconfined", + "RuntimeDefault", + "Localhost" + ], + "x-enum-varnames": [ + "SeccompProfileTypeUnconfined", + "SeccompProfileTypeRuntimeDefault", + "SeccompProfileTypeLocalhost" + ] + }, + "v1.SecretEnvSource": { + "type": "object", + "properties": { + "name": { + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", + "type": "string" + }, + "optional": { + "description": "Specify whether the Secret must be defined\n+optional", + "type": "boolean" + } + } + }, + "v1.SecretKeySelector": { + "type": "object", + "properties": { + "key": { + "description": "The key of the secret to select from. Must be a valid secret key.", + "type": "string" + }, + "name": { + "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", + "type": "string" + }, + "optional": { + "description": "Specify whether the Secret or its key must be defined\n+optional", + "type": "boolean" + } + } + }, + "v1.SecurityContext": { + "type": "object", + "properties": { + "allowPrivilegeEscalation": { + "description": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows.\n+optional", + "type": "boolean" + }, + "capabilities": { + "description": "The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.Capabilities" + } + ] + }, + "privileged": { + "description": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", + "type": "boolean" + }, + "procMount": { + "description": "procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.ProcMountType" + } + ] + }, + "readOnlyRootFilesystem": { + "description": "Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", + "type": "boolean" + }, + "runAsGroup": { + "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", + "type": "integer" + }, + "runAsNonRoot": { + "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", + "type": "boolean" + }, + "runAsUser": { + "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", + "type": "integer" + }, + "seLinuxOptions": { + "description": "The SELinux context to be applied to the container.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.SELinuxOptions" + } + ] + }, + "seccompProfile": { + "description": "The seccomp options to use by this container. If seccomp options are\nprovided at both the pod \u0026 container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.SeccompProfile" + } + ] + }, + "windowsOptions": { + "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.WindowsSecurityContextOptions" + } + ] + } + } + }, + "v1.TCPSocketAction": { + "type": "object", + "properties": { + "host": { + "description": "Optional: Host name to connect to, defaults to the pod IP.\n+optional", + "type": "string" + }, + "port": { + "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", + "allOf": [ + { + "$ref": "#/definitions/intstr.IntOrString" + } + ] + } + } + }, + "v1.TerminationMessagePolicy": { + "type": "string", + "enum": [ + "File", + "FallbackToLogsOnError" + ], + "x-enum-varnames": [ + "TerminationMessageReadFile", + "TerminationMessageFallbackToLogsOnError" + ] + }, + "v1.URIScheme": { + "type": "string", + "enum": [ + "HTTP", + "HTTPS" + ], + "x-enum-varnames": [ + "URISchemeHTTP", + "URISchemeHTTPS" + ] + }, + "v1.VolumeDevice": { + "type": "object", + "properties": { + "devicePath": { + "description": "devicePath is the path inside of the container that the device will be mapped to.", + "type": "string" + }, + "name": { + "description": "name must match the name of a persistentVolumeClaim in the pod", + "type": "string" + } + } + }, + "v1.VolumeMount": { + "type": "object", + "properties": { + "mountPath": { + "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.", + "type": "string" + }, + "mountPropagation": { + "description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\n+optional", + "allOf": [ + { + "$ref": "#/definitions/v1.MountPropagationMode" + } + ] + }, + "name": { + "description": "This must match the Name of a Volume.", + "type": "string" + }, + "readOnly": { + "description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.\n+optional", + "type": "boolean" + }, + "subPath": { + "description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).\n+optional", + "type": "string" + }, + "subPathExpr": { + "description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.\n+optional", + "type": "string" + } + } + }, + "v1.WindowsSecurityContextOptions": { + "type": "object", + "properties": { + "gmsaCredentialSpec": { + "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.\n+optional", + "type": "string" + }, + "gmsaCredentialSpecName": { + "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.\n+optional", + "type": "string" + }, + "hostProcess": { + "description": "HostProcess determines if a container should be run as a 'Host Process' container.\nThis field is alpha-level and will only be honored by components that enable the\nWindowsHostProcessContainers feature flag. Setting this field without the feature\nflag will result in errors when validating the Pod. All of a Pod's containers must\nhave the same effective HostProcess value (it is not allowed to have a mix of HostProcess\ncontainers and non-HostProcess containers). In addition, if HostProcess is true\nthen HostNetwork must also be set to true.\n+optional", + "type": "boolean" + }, + "runAsUserName": { + "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", + "type": "string" + } + } } } }` @@ -7430,6 +8675,8 @@ var SwaggerInfo = &swag.Spec{ Description: "", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, + LeftDelim: "{{", + RightDelim: "}}", } func init() { diff --git a/docs/index.html b/docs/index.html index bc2ec2a24..86ec9be8f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,27 +13,21 @@ } -
API docs by Redocly
Documentation Powered by ReDoc

Konveyor Hub API (0.3.z)

Download OpenAPI specification:Download

License: Apache 2.0

addons

List all addons.

List all addons.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an addon by name.

Get an addon by name.

-
path Parameters
name
required
string

Addon name

-

Responses

Response samples

Content type
application/json
{
  • "image": "string",
  • "name": "string"
}

adoptionplans

Generate an application dependency graph arranged in topological order.

Graph generates an application dependency graph arranged in topological order.

-
Request Body schema: application/json

List of requested App IDs

-
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
[
  • {
    }
]

analyses

List analyses.

List analyses for an application. + " fill="currentColor">

Konveyor Hub API (0.3.z)

Download OpenAPI specification:Download

License: Apache 2.0

addons

List all addons.

List all addons.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an addon by name.

Get an addon by name.

+
path Parameters
name
required
string

Addon name

+

Responses

Response samples

Content type
application/json
{
  • "container": {
    },
  • "extensions": [
    ],
  • "metadata": { },
  • "name": "string"
}

adoptionplans

Generate an application dependency graph arranged in topological order.

Graph generates an application dependency graph arranged in topological order.

+
Request Body schema: application/json

List of requested App IDs

+
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
[
  • {
    }
]

analyses

List analyses.

List analyses for an application. Resources do not include relations.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an analysis (report) by ID.

Get an analysis (report) by ID.

-
path Parameters
id
required
integer

Analysis ID

-

Responses

Delete an analysis by ID.

Delete an analysis by ID.

-
path Parameters
id
required
integer

Analysis ID

-

Responses

Create an analysis.

Create an analysis. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an analysis (report) by ID.

Get an analysis (report) by ID.

+
path Parameters
id
required
integer

Analysis ID

+

Responses

Delete an analysis by ID.

Delete an analysis by ID.

+
path Parameters
id
required
integer

Analysis ID

+

Responses

Archive an analysis (report) by ID.

Archive an analysis (report) by ID.

+
path Parameters
id
required
integer

Analysis ID

+

Responses

Create an analysis.

Create an analysis. Form fields:

  • file: file that contains the api.Analysis resource.
  • issues: file that multiple api.Issue resources.
  • dependencies: file that multiple api.TechDependency resources.
-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
{
  • "archived": true,
  • "createTime": "string",
  • "createUser": "string",
  • "dependencies": [
    ],
  • "effort": 0,
  • "id": 0,
  • "issues": [
    ],
  • "summary": { },
  • "updateUser": "string"
}

Get the latest analysis.

Get the latest analysis for an application.

-
path Parameters
id
required
integer

Application ID

-

Responses

Get the latest analysis (static) report.

Get the latest analysis (static) report.

-
path Parameters
id
required
integer

Application ID

-

Responses

dependencies

List dependency reports.

Each report collates dependencies by name and SHA. +

path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archived": true,
  • "commit": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "dependencies": [
    ],
  • "effort": 0,
  • "id": 0,
  • "issues": [
    ],
  • "summary": { },
  • "updateUser": "string"
}

Get the latest analysis.

Get the latest analysis for an application.

+
path Parameters
id
required
integer

Application ID

+

Responses

Get the latest analysis (static) report.

Get the latest analysis (static) report.

+
path Parameters
id
required
integer

Application ID

+

Responses

dependencies

List dependency reports.

Each report collates dependencies by name and SHA. filters:

  • provider
    • @@ -2246,8 +2176,19 @@
  • name
  • labels
-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List application dependencies.

List application dependencies. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List analysis dependencies.

List analysis dependencies. +filters:

+
    +
  • name
    • +
  • version
    • +
  • sha
    • +
  • indirect
    • +
  • labels
    • +
+
path Parameters
id
required
integer

Analysis ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List application dependencies.

List application dependencies. filters:

  • name
    • @@ -2256,20 +2197,40 @@
  • indirect
  • labels
-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all dependencies.

List all dependencies.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a dependency.

Create a dependency.

-
Request Body schema: application/json

Dependency data

-
createTime
string
createUser
string
object (api.Ref)
id
integer
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "from": {
    },
  • "id": 0,
  • "to": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "from": {
    },
  • "id": 0,
  • "to": {
    },
  • "updateUser": "string"
}

Get a dependency by ID.

Get a dependency by ID.

-
path Parameters
id
required
integer

Dependency ID

-

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "from": {
    },
  • "id": 0,
  • "to": {
    },
  • "updateUser": "string"
}

Delete a dependency.

Delete a dependency.

-
path Parameters
id
required
integer

Dependency id

-

Responses

issues

List all issues.

List all issues. +

path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all dependencies.

List all dependencies.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a dependency.

Create a dependency.

+
Request Body schema: application/json

Dependency data

+
createTime
string
createUser
string
object (api.Ref)
id
integer
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "from": {
    },
  • "id": 0,
  • "to": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "from": {
    },
  • "id": 0,
  • "to": {
    },
  • "updateUser": "string"
}

Get a dependency by ID.

Get a dependency by ID.

+
path Parameters
id
required
integer

Dependency ID

+

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "from": {
    },
  • "id": 0,
  • "to": {
    },
  • "updateUser": "string"
}

Delete a dependency.

Delete a dependency.

+
path Parameters
id
required
integer

Dependency id

+

Responses

incidents

List all incidents.

List all incidents. +filters:

+
    +
  • file
    • +
  • issue.id
    • +
+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List incidents for an issue.

List incidents for an issue. +filters:

+
    +
  • file
    • +
+
path Parameters
id
required
integer

Issue ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

issue

Get an incident.

Get an incident.

+
path Parameters
id
required
integer

Issue ID

+

Responses

Response samples

Content type
application/json
{
  • "codeSnip": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "facts": {
    },
  • "file": "string",
  • "id": 0,
  • "issue": 0,
  • "line": 0,
  • "message": "string",
  • "updateUser": "string"
}

Get an issue.

Get an issue.

+
path Parameters
id
required
integer

Issue ID

+

Responses

Response samples

Content type
application/json
{
  • "analysis": 0,
  • "category": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "facts": {
    },
  • "id": 0,
  • "incidents": [
    ],
  • "labels": [
    ],
  • "links": [
    ],
  • "name": "string",
  • "rule": "string",
  • "ruleset": "string",
  • "updateUser": "string"
}

issues

List all issues.

List all issues. filters:

  • ruleset
    • @@ -2282,8 +2243,8 @@
  • application.name
  • tag.id
-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List application issues.

List application issues. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List issues for an analysis.

List issues for an analysis. filters:

  • ruleset
    • @@ -2293,19 +2254,21 @@
  • effort
  • labels
-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

issue

Get an issue.

Get an issue.

-
path Parameters
id
required
integer

Issue ID

-

Responses

Response samples

Content type
application/json
{
  • "category": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "facts": { },
  • "id": 0,
  • "incidents": [
    ],
  • "labels": [
    ],
  • "links": [
    ],
  • "name": "string",
  • "rule": "string",
  • "ruleset": "string",
  • "updateUser": "string"
}

incidents

List incidents for an issue.

List incidents for an issue. +

path Parameters
id
required
integer

Analysis ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List application issues.

List application issues. filters:

    -
  • file
    • +
  • ruleset
    • +
  • rule
    • +
  • name
    • +
  • category
    • +
  • effort
    • +
  • labels
-
path Parameters
id
required
integer

Issue ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

depappreports

List application reports.

List application reports. +

path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

depappreports

List application reports.

List application reports. filters:

  • id
    • @@ -2337,8 +2300,8 @@
  • sha
  • indirect
-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

issuereport

List application issue reports.

Each report collates issues by ruleset/rule. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

issuereport

List application issue reports.

Each report collates issues by ruleset/rule. filters:

  • ruleset
    • @@ -2353,9 +2316,9 @@
  • effort
  • files
-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

filereports

List incident file reports.

Each report collates incidents by file. +

path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

filereports

List incident file reports.

Each report collates incidents by file. filters:

  • file
    • @@ -2366,9 +2329,9 @@
  • effort
  • incidents
-
path Parameters
id
required
integer

Issue ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

rulereports

List rule reports.

Each report collates issues by ruleset/rule. +

path Parameters
id
required
integer

Issue ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

rulereports

List rule reports.

Each report collates issues by ruleset/rule. filters:

  • ruleset
    • @@ -2389,575 +2352,586 @@
  • effort
  • applications
-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

applications

List all applications.

List all applications.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an application.

Create an application.

-
Request Body schema: application/json

Application data

-
Array of objects (api.Ref)
assessed
boolean
Array of objects (api.Ref)
binary
string
object (api.Ref)
object (api.Ref)
comments
string
confidence
integer
Array of objects (api.Ref)
createTime
string
createUser
string
description
string
effort
integer
id
integer
Array of objects (api.Ref)
object (api.Ref)
name
required
string
object (api.Ref)
object (api.Repository)
object (api.Ref)
risk
string
Array of objects (api.TagRef)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete a applications.

Delete applications.

-
Request Body schema: application/json

List of id

-
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Get an application by ID.

Get an application by ID.

-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Update an application.

Update an application.

-
path Parameters
id
required
integer

Application id

-
Request Body schema: application/json

Application data

-
Array of objects (api.Ref)
assessed
boolean
Array of objects (api.Ref)
binary
string
object (api.Ref)
object (api.Ref)
comments
string
confidence
integer
Array of objects (api.Ref)
createTime
string
createUser
string
description
string
effort
integer
id
integer
Array of objects (api.Ref)
object (api.Ref)
name
required
string
object (api.Ref)
object (api.Repository)
object (api.Ref)
risk
string
Array of objects (api.TagRef)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete an application.

Delete an application.

-
path Parameters
id
required
integer

Application id

-

Responses

List the assessments of an Application and any it inherits from its archetypes.

List the assessments of an Application and any it inherits from its archetypes.

-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an application assessment.

Create an application assessment.

-
path Parameters
id
required
integer

Application ID

-
Request Body schema: application/json

Assessment data

-
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
risk
string

read only

-
object (assessment.RiskMessages)
Array of objects (assessment.Section)
Array of objects (api.Ref)
Array of objects (api.Ref)
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Get bucket content by ID and path.

Get bucket content by ID and path. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

applications

List all applications.

List all applications.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an application.

Create an application.

+
Request Body schema: application/json

Application data

+
Array of objects (api.Ref) [ items ]
assessed
boolean
Array of objects (api.Ref) [ items ]
binary
string
object (api.Ref)
object (api.Ref)
comments
string
confidence
integer
Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
description
string
effort
integer
id
integer
Array of objects (api.Ref) [ items ]
object (api.Ref)
name
required
string
object (api.Ref)
object (api.Repository)
object (api.Ref)
risk
string
Array of objects (api.TagRef) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete a applications.

Delete applications.

+
Request Body schema: application/json

List of id

+
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Get an application by ID.

Get an application by ID.

+
path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Update an application.

Update an application.

+
path Parameters
id
required
integer

Application id

+
Request Body schema: application/json

Application data

+
Array of objects (api.Ref) [ items ]
assessed
boolean
Array of objects (api.Ref) [ items ]
binary
string
object (api.Ref)
object (api.Ref)
comments
string
confidence
integer
Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
description
string
effort
integer
id
integer
Array of objects (api.Ref) [ items ]
object (api.Ref)
name
required
string
object (api.Ref)
object (api.Repository)
object (api.Ref)
risk
string
Array of objects (api.TagRef) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "archetypes": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "binary": "string",
  • "bucket": {
    },
  • "businessService": {
    },
  • "comments": "string",
  • "confidence": 0,
  • "contributors": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "effort": 0,
  • "id": 0,
  • "identities": [
    ],
  • "migrationWave": {
    },
  • "name": "string",
  • "owner": {
    },
  • "repository": {
    },
  • "review": {
    },
  • "risk": "string",
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete an application.

Delete an application.

+
path Parameters
id
required
integer

Application id

+

Responses

List the assessments of an Application and any it inherits from its archetypes.

List the assessments of an Application and any it inherits from its archetypes.

+
path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an application assessment.

Create an application assessment.

+
path Parameters
id
required
integer

Application ID

+
Request Body schema: application/json

Assessment data

+
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
required
boolean
risk
string

read only

+
object (assessment.RiskMessages)
Array of objects (assessment.Section) [ items ]
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "required": true,
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "required": true,
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Get bucket content by ID and path.

Get bucket content by ID and path. Returns index.html for directories when Accept=text/html else a tarball. ?filter=glob supports directory content filtering.

-
path Parameters
id
required
integer

Application ID

-
wildcard
required
string

Content path

-
query Parameters
filter
string

Filter

-

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

-
path Parameters
id
required
integer

Application ID

-
wildcard
required
string

Content path

-

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

-
path Parameters
id
required
integer

Application ID

-
wildcard
required
string

Content path

-

Responses

Create a fact.

Create a fact.

-
path Parameters
id
required
integer

Application ID

-
Request Body schema: application/json

Fact data

-
key
string
source
string
value
object

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "source": "string",
  • "value": { }
}

Get fact by name.

Get fact by name. +

path Parameters
id
required
integer

Application ID

+
wildcard
required
string

Content path

+
query Parameters
filter
string

Filter

+

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

+
path Parameters
id
required
integer

Application ID

+
wildcard
required
string

Content path

+

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

+
path Parameters
id
required
integer

Application ID

+
wildcard
required
string

Content path

+

Responses

Create a fact.

Create a fact.

+
path Parameters
id
required
integer

Application ID

+
Request Body schema: application/json

Fact data

+
key
string
source
string
value
object

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "source": "string",
  • "value": { }
}

Get fact by name.

Get fact by name. see api.FactKey for details on key parameter format.

-
path Parameters
id
required
integer

Application ID

-
key
required
string

Fact key

-

Responses

Response samples

Content type
application/json
{ }

Update (or create) a fact.

Update (or create) a fact. +

path Parameters
id
required
integer

Application ID

+
key
required
string

Fact key

+

Responses

Response samples

Content type
application/json
{ }

Update (or create) a fact.

Update (or create) a fact. see api.FactKey for details on key parameter format.

-
path Parameters
id
required
integer

Application ID

-
key
required
string

Fact key

-
Request Body schema: application/json

Fact value

-
object

Responses

Request samples

Content type
application/json
{ }

Delete a fact.

Delete a fact. +

path Parameters
id
required
integer

Application ID

+
key
required
string

Fact key

+
Request Body schema: application/json

Fact value

+
object

Responses

Request samples

Content type
application/json
{ }

Delete a fact.

Delete a fact. see api.FactKey for details on key parameter format.

-
path Parameters
id
required
integer

Application ID

-
key
required
string

Fact key

-

Responses

List facts.

List facts by source. +

path Parameters
id
required
integer

Application ID

+
key
required
string

Fact key

+

Responses

List facts.

List facts by source. see api.FactKey for details on key parameter format.

-
path Parameters
id
required
integer

Application ID

-
source
required
string

Source key

-

Responses

Response samples

Content type
application/json
{ }

Replace all facts from a source.

Replace all facts from a source. +

path Parameters
id
required
integer

Application ID

+
source
required
string

Source key

+

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Replace all facts from a source.

Replace all facts from a source. see api.FactKey for details on key parameter format.

-
path Parameters
id
required
integer

Application ID

-
source
required
string

Fact key

-
Request Body schema: application/json

Fact map

-
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Update the owner and contributors of an Application.

Update the owner and contributors of an Application.

-
path Parameters
id
required
integer

Application ID

-
Request Body schema: application/json

Application stakeholders

-
Array of objects (api.Ref)
object (api.Ref)

Responses

Request samples

Content type
application/json
{
  • "contributors": [
    ],
  • "owner": {
    }
}

List tag references.

List tag references.

-
path Parameters
id
required
integer

Application ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add tag association.

Ensure tag is associated with the application.

-
path Parameters
id
required
integer

Application ID

-
Request Body schema: application/json

Tag data

-
id
required
integer
name
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Replace tag associations.

Replace tag associations.

-
path Parameters
id
required
integer

Application ID

-
query Parameters
source
string

Source

-
Request Body schema: application/json

Tag references

-
Array
id
required
integer
name
string
source
string
virtual
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete tag association.

Ensure tag is not associated with the application.

-
path Parameters
id
required
integer

Application ID

-
sid
required
string

Tag ID

-

Responses

archetypes

List all archetypes.

List all archetypes.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an archetype.

Create an archetype.

-
Request Body schema: application/json

Archetype data

-
Array of objects (api.Ref)
assessed
boolean
Array of objects (api.Ref)
comments
string
confidence
integer
createTime
string
createUser
string
Array of objects (api.TagRef)
description
string
id
integer
name
string
object (api.Ref)
risk
string
Array of objects (api.Ref)
Array of objects (api.Ref)
Array of objects (api.TagRef)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Get an archetype by ID.

Get an archetype by ID.

-
path Parameters
id
required
integer

Archetype ID

-

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Update an archetype.

Update an archetype.

-
path Parameters
id
required
integer

Archetype ID

-
Request Body schema: application/json

Archetype data

-
Array of objects (api.Ref)
assessed
boolean
Array of objects (api.Ref)
comments
string
confidence
integer
createTime
string
createUser
string
Array of objects (api.TagRef)
description
string
id
integer
name
string
object (api.Ref)
risk
string
Array of objects (api.Ref)
Array of objects (api.Ref)
Array of objects (api.TagRef)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete an archetype.

Delete an archetype.

-
path Parameters
id
required
integer

Archetype ID

-

Responses

List the assessments of an archetype.

List the assessments of an archetype.

-
path Parameters
id
required
integer

Archetype ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an archetype assessment.

Create an archetype assessment.

-
path Parameters
id
required
integer

Archetype ID

-
Request Body schema: application/json

Assessment data

-
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
risk
string

read only

-
object (assessment.RiskMessages)
Array of objects (assessment.Section)
Array of objects (api.Ref)
Array of objects (api.Ref)
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

assessments

List all assessments.

List all assessments.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an assessment.

Update an assessment.

-
path Parameters
id
required
integer

Assessment ID

-
Request Body schema: application/json

Assessment data

-
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
risk
string

read only

-
object (assessment.RiskMessages)
Array of objects (assessment.Section)
Array of objects (api.Ref)
Array of objects (api.Ref)
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Delete an assessment.

Delete an assessment.

-
path Parameters
id
required
integer

Assessment ID

-

Responses

questionnaires

Get an assessment by ID.

Get an assessment by ID.

-
path Parameters
id
required
integer

Assessment ID

-

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

List all questionnaires.

List all questionnaires.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a questionnaire.

Create a questionnaire.

-
Request Body schema: application/json

Questionnaire data

-
builtin
boolean
createTime
string
createUser
string
description
string
id
integer
name
required
string
required
boolean
required
object (assessment.RiskMessages)
required
Array of objects (assessment.Section)
required
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Get a questionnaire by ID.

Get a questionnaire by ID.

-
path Parameters
id
required
integer

Questionnaire ID

-

Responses

Response samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Update a questionnaire.

Update a questionnaire. If the Questionnaire +

path Parameters
id
required
integer

Application ID

+
source
required
string

Fact key

+
Request Body schema: application/json

Fact map

+
property name*
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Update the owner and contributors of an Application.

Update the owner and contributors of an Application.

+
path Parameters
id
required
integer

Application ID

+
Request Body schema: application/json

Application stakeholders

+
Array of objects (api.Ref) [ items ]
object (api.Ref)

Responses

Request samples

Content type
application/json
{
  • "contributors": [
    ],
  • "owner": {
    }
}

List tag references.

List tag references.

+
path Parameters
id
required
integer

Application ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add tag association.

Ensure tag is associated with the application.

+
path Parameters
id
required
integer

Application ID

+
Request Body schema: application/json

Tag data

+
id
required
integer
name
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Replace tag associations.

Replace tag associations.

+
path Parameters
id
required
integer

Application ID

+
query Parameters
source
string

Source

+
Request Body schema: application/json

Tag references

+
Array
id
required
integer
name
string
source
string
virtual
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete tag association.

Ensure tag is not associated with the application.

+
path Parameters
id
required
integer

Application ID

+
sid
required
string

Tag ID

+

Responses

archetypes

List all archetypes.

List all archetypes.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an archetype.

Create an archetype.

+
Request Body schema: application/json

Archetype data

+
Array of objects (api.Ref) [ items ]
assessed
boolean
Array of objects (api.Ref) [ items ]
comments
string
confidence
integer
createTime
string
createUser
string
Array of objects (api.TagRef) [ items ]
description
string
id
integer
name
string
object (api.Ref)
risk
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
Array of objects (api.TagRef) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Get an archetype by ID.

Get an archetype by ID.

+
path Parameters
id
required
integer

Archetype ID

+

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Update an archetype.

Update an archetype.

+
path Parameters
id
required
integer

Archetype ID

+
Request Body schema: application/json

Archetype data

+
Array of objects (api.Ref) [ items ]
assessed
boolean
Array of objects (api.Ref) [ items ]
comments
string
confidence
integer
createTime
string
createUser
string
Array of objects (api.TagRef) [ items ]
description
string
id
integer
name
string
object (api.Ref)
risk
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
Array of objects (api.TagRef) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "assessed": true,
  • "assessments": [
    ],
  • "comments": "string",
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "criteria": [
    ],
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "review": {
    },
  • "risk": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "tags": [
    ],
  • "updateUser": "string"
}

Delete an archetype.

Delete an archetype.

+
path Parameters
id
required
integer

Archetype ID

+

Responses

List the assessments of an archetype.

List the assessments of an archetype.

+
path Parameters
id
required
integer

Archetype ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an archetype assessment.

Create an archetype assessment.

+
path Parameters
id
required
integer

Archetype ID

+
Request Body schema: application/json

Assessment data

+
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
required
boolean
risk
string

read only

+
object (assessment.RiskMessages)
Array of objects (assessment.Section) [ items ]
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "required": true,
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "required": true,
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

assessments

List all assessments.

List all assessments.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an assessment.

Update an assessment.

+
path Parameters
id
required
integer

Assessment ID

+
Request Body schema: application/json

Assessment data

+
object (api.Ref)
object (api.Ref)
confidence
integer
createTime
string
createUser
string
id
integer
required
object (api.Ref)
required
boolean
risk
string

read only

+
object (assessment.RiskMessages)
Array of objects (assessment.Section) [ items ]
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
status
string
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "required": true,
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

Delete an assessment.

Delete an assessment.

+
path Parameters
id
required
integer

Assessment ID

+

Responses

questionnaires

Get an assessment by ID.

Get an assessment by ID.

+
path Parameters
id
required
integer

Assessment ID

+

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "confidence": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "questionnaire": {
    },
  • "required": true,
  • "risk": "string",
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "status": "string",
  • "thresholds": {
    },
  • "updateUser": "string"
}

List all questionnaires.

List all questionnaires.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a questionnaire.

Create a questionnaire.

+
Request Body schema: application/json

Questionnaire data

+
builtin
boolean
createTime
string
createUser
string
description
string
id
integer
name
required
string
required
boolean
required
object (assessment.RiskMessages)
required
Array of objects (assessment.Section) non-empty [ items ]
required
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Get a questionnaire by ID.

Get a questionnaire by ID.

+
path Parameters
id
required
integer

Questionnaire ID

+

Responses

Response samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Update a questionnaire.

Update a questionnaire. If the Questionnaire is builtin, only its "required" field can be changed and all other fields will be ignored.

-
path Parameters
id
required
integer

Questionnaire ID

-
Request Body schema: application/json

Questionnaire data

-
builtin
boolean
createTime
string
createUser
string
description
string
id
integer
name
required
string
required
boolean
required
object (assessment.RiskMessages)
required
Array of objects (assessment.Section)
required
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Delete a questionnaire.

Delete a questionnaire.

-
path Parameters
id
required
integer

Questionnaire ID

-

Responses

auth

Login and obtain a bearer token.

Login and obtain a bearer token.

-

Responses

Response samples

Content type
application/json
{
  • "expiry": 0,
  • "password": "string",
  • "refresh": "string",
  • "token": "string",
  • "user": "string"
}

Refresh bearer token.

Refresh bearer token.

-

Responses

Response samples

Content type
application/json
{
  • "expiry": 0,
  • "password": "string",
  • "refresh": "string",
  • "token": "string",
  • "user": "string"
}

batch

Batch-create Tags.

Batch-create Tags.

-
Request Body schema: application/json

Tags data

-
Array
required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Batch-create Tickets.

Batch-create Tickets.

-
Request Body schema: application/json

Tickets data

-
Array
required
object (api.Ref)
createTime
string
createUser
string
error
boolean
object (api.Fields)
id
integer
kind
required
string
lastUpdated
string
link
string
message
string
parent
required
string
reference
string
status
string
required
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

tags

Batch-create Tags.

Batch-create Tags.

-
Request Body schema: application/json

Tags data

-
Array
required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List all tags.

List all tags.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a tag.

Create a tag.

-
Request Body schema: application/json

Tag data

-
required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Get a tag by ID.

Get a tag by ID.

-
path Parameters
id
required
integer

Tag ID

-

Responses

Response samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Update a tag.

Update a tag.

-
path Parameters
id
required
integer

Tag ID

-
Request Body schema: application/json

Tag data

-
required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Delete a tag.

Delete a tag.

-
path Parameters
id
required
integer

Tag ID

-

Responses

tickets

Batch-create Tickets.

Batch-create Tickets.

-
Request Body schema: application/json

Tickets data

-
Array
required
object (api.Ref)
createTime
string
createUser
string
error
boolean
object (api.Fields)
id
integer
kind
required
string
lastUpdated
string
link
string
message
string
parent
required
string
reference
string
status
string
required
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List all tickets.

List all tickets.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a ticket.

Create a ticket.

-
Request Body schema: application/json

Ticket data

-
required
object (api.Ref)
createTime
string
createUser
string
error
boolean
object (api.Fields)
id
integer
kind
required
string
lastUpdated
string
link
string
message
string
parent
required
string
reference
string
status
string
required
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": { },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": { },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Get a ticket by ID.

Get a ticket by ID.

-
path Parameters
id
required
integer

Ticket ID

-

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": { },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Delete a ticket.

Delete a ticket.

-
path Parameters
id
required
integer

Ticket id

-

Responses

buckets

List all buckets.

List all buckets.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a bucket.

Create a bucket.

-
path Parameters
name
required
string

Bucket name

-

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "expiration": "string",
  • "id": 0,
  • "path": "string",
  • "updateUser": "string"
}

Get a bucket by ID.

Get a bucket by ID. +

path Parameters
id
required
integer

Questionnaire ID

+
Request Body schema: application/json

Questionnaire data

+
builtin
boolean
createTime
string
createUser
string
description
string
id
integer
name
required
string
required
boolean
required
object (assessment.RiskMessages)
required
Array of objects (assessment.Section) non-empty [ items ]
required
object (assessment.Thresholds)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "builtin": true,
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "required": true,
  • "riskMessages": {
    },
  • "sections": [
    ],
  • "thresholds": {
    },
  • "updateUser": "string"
}

Delete a questionnaire.

Delete a questionnaire.

+
path Parameters
id
required
integer

Questionnaire ID

+

Responses

auth

Login and obtain a bearer token.

Login and obtain a bearer token.

+

Responses

Response samples

Content type
application/json
{
  • "expiry": 0,
  • "password": "string",
  • "refresh": "string",
  • "token": "string",
  • "user": "string"
}

Refresh bearer token.

Refresh bearer token.

+

Responses

Response samples

Content type
application/json
{
  • "expiry": 0,
  • "password": "string",
  • "refresh": "string",
  • "token": "string",
  • "user": "string"
}

batch

Batch-create Tags.

Batch-create Tags.

+
Request Body schema: application/json

Tags data

+
Array
required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Batch-create Tickets.

Batch-create Tickets.

+
Request Body schema: application/json

Tickets data

+
Array
required
object (api.Ref)
createTime
string
createUser
string
error
boolean
object (api.Fields)
id
integer
kind
required
string
lastUpdated
string
link
string
message
string
parent
required
string
reference
string
status
string
required
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

tags

Batch-create Tags.

Batch-create Tags.

+
Request Body schema: application/json

Tags data

+
Array
required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List all tags.

List all tags.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a tag.

Create a tag.

+
Request Body schema: application/json

Tag data

+
required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Get a tag by ID.

Get a tag by ID.

+
path Parameters
id
required
integer

Tag ID

+

Responses

Response samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Update a tag.

Update a tag.

+
path Parameters
id
required
integer

Tag ID

+
Request Body schema: application/json

Tag data

+
required
object (api.Ref)
createTime
string
createUser
string
id
integer
name
required
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "category": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "updateUser": "string"
}

Delete a tag.

Delete a tag.

+
path Parameters
id
required
integer

Tag ID

+

Responses

tickets

Batch-create Tickets.

Batch-create Tickets.

+
Request Body schema: application/json

Tickets data

+
Array
required
object (api.Ref)
createTime
string
createUser
string
error
boolean
object (api.Fields)
id
integer
kind
required
string
lastUpdated
string
link
string
message
string
parent
required
string
reference
string
status
string
required
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List all tickets.

List all tickets.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a ticket.

Create a ticket.

+
Request Body schema: application/json

Ticket data

+
required
object (api.Ref)
createTime
string
createUser
string
error
boolean
object (api.Fields)
id
integer
kind
required
string
lastUpdated
string
link
string
message
string
parent
required
string
reference
string
status
string
required
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": {
    },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": {
    },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Get a ticket by ID.

Get a ticket by ID.

+
path Parameters
id
required
integer

Ticket ID

+

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "error": true,
  • "fields": {
    },
  • "id": 0,
  • "kind": "string",
  • "lastUpdated": "string",
  • "link": "string",
  • "message": "string",
  • "parent": "string",
  • "reference": "string",
  • "status": "string",
  • "tracker": {
    },
  • "updateUser": "string"
}

Delete a ticket.

Delete a ticket.

+
path Parameters
id
required
integer

Ticket id

+

Responses

buckets

List all buckets.

List all buckets.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a bucket.

Create a bucket.

+
path Parameters
name
required
string

Bucket name

+

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "expiration": "string",
  • "id": 0,
  • "path": "string",
  • "updateUser": "string"
}

Get a bucket by ID.

Get a bucket by ID. Returns api.Bucket when Accept=application/json. Else returns index.html when Accept=text/html. Else returns tarball.

-
path Parameters
id
required
integer

Bucket ID

-

Responses

Delete a bucket.

Delete a bucket.

-
path Parameters
id
required
integer

Bucket ID

-

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. +

path Parameters
id
required
integer

Bucket ID

+

Responses

Delete a bucket.

Delete a bucket.

+
path Parameters
id
required
integer

Bucket ID

+

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. When path is FILE, returns file content. When path is DIRECTORY and Accept=text/html returns index.html. ?filter=glob supports directory content filtering. Else returns a tarball.

-
path Parameters
id
required
integer

Task ID

-
wildcard
required
string

Content path

-
query Parameters
filter
string

Filter

-

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

-
path Parameters
id
required
integer

Bucket ID

-
wildcard
required
string

Content path

-

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

-
path Parameters
id
required
integer

Bucket ID

-
wildcard
required
string

Content path

-

Responses

businessservices

List all business services.

List all business services.

-

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Create a business service.

Create a business service.

-
Request Body schema: application/json

Business service data

-
createTime
string
createUser
string
description
string
id
integer
name
required
string
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Get a business service by ID.

Get a business service by ID.

-
path Parameters
id
required
integer

Business Service ID

-

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Update a business service.

Update a business service.

-
path Parameters
id
required
integer

Business service ID

-
Request Body schema: application/json

Business service data

-
createTime
string
createUser
string
description
string
id
integer
name
required
string
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Delete a business service.

Delete a business service.

-
path Parameters
id
required
integer

Business service ID

-

Responses

cache

Delete a directory within the cache.

Delete a directory within the cache.

-

Responses

Get the cache.

Get the cache.

-
path Parameters
wildcard
required
string

Cache DIR

-

Responses

Response samples

Content type
application/json
{
  • "capacity": "string",
  • "exists": true,
  • "path": "string",
  • "used": "string"
}

file

List all files.

List all files.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a file.

Create a file.

-
path Parameters
name
required
string

File name

-

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "expiration": "string",
  • "id": 0,
  • "name": "string",
  • "path": "string",
  • "updateUser": "string"
}

Get a file by ID.

Get a file by ID. Returns api.File when Accept=application/json else the file content.

-
path Parameters
id
required
integer

File ID

-

Responses

Delete a file.

Delete a file.

-
path Parameters
id
required
integer

File ID

-

Responses

identities

List all identities.

List all identities.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an identity.

Create an identity.

-
Request Body schema: application/json

Identity data

-
createTime
string
createUser
string
description
string
id
integer
key
string
kind
required
string
name
required
string
password
string
settings
string
updateUser
string
user
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Get an identity by ID.

Get an identity by ID.

-
path Parameters
id
required
integer

Identity ID

-

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Update an identity.

Update an identity.

-
path Parameters
id
required
integer

Identity ID

-
Request Body schema: application/json

Identity data

-
createTime
string
createUser
string
description
string
id
integer
key
string
kind
required
string
name
required
string
password
string
settings
string
updateUser
string
user
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Delete an identity.

Delete an identity.

-
path Parameters
id
required
integer

Identity ID

-

Responses

imports

List imports.

List imports.

-

Responses

Response samples

Content type
application/json
[
  • { }
]

Get an import by ID.

Get an import by ID.

-
path Parameters
id
required
integer

Import ID

-

Responses

Response samples

Content type
application/json
{ }

Delete an import.

Delete an import. This leaves any created application or dependency.

-
path Parameters
id
required
integer

Import ID

-

Responses

List import summaries.

List import summaries.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export the source CSV for a particular import summary.

Export the source CSV for a particular import summary.

-
query Parameters
importSummary.id
required
string

ImportSummary ID

-

Responses

Upload a CSV containing applications and dependencies to import.

Upload a CSV containing applications and dependencies to import.

-

Responses

Response samples

Content type
application/json
{
  • "createEntities": true,
  • "createTime": "string",
  • "createUser": "string",
  • "filename": "string",
  • "id": 0,
  • "importStatus": "string",
  • "importTime": "string",
  • "invalidCount": 0,
  • "updateUser": "string",
  • "validCount": 0
}

Get an import summary by ID.

Get an import by ID.

-
path Parameters
id
required
integer

ImportSummary ID

-

Responses

Response samples

Content type
application/json
{
  • "createEntities": true,
  • "createTime": "string",
  • "createUser": "string",
  • "filename": "string",
  • "id": 0,
  • "importStatus": "string",
  • "importTime": "string",
  • "invalidCount": 0,
  • "updateUser": "string",
  • "validCount": 0
}

Delete an import summary and associated import records.

Delete an import summary and associated import records.

-
path Parameters
id
required
integer

ImportSummary ID

-

Responses

jobfunctions

List all job functions.

List all job functions.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a job function.

Create a job function.

-
Request Body schema: application/json

Job Function data

-
createTime
string
createUser
string
id
integer
name
required
string
Array of objects (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Get a job function by ID.

Get a job function by ID.

-
path Parameters
id
required
integer

Job Function ID

-

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Update a job function.

Update a job function.

-
path Parameters
id
required
integer

Job Function ID

-
Request Body schema: application/json

Job Function data

-
createTime
string
createUser
string
id
integer
name
required
string
Array of objects (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Delete a job function.

Delete a job function.

-
path Parameters
id
required
integer

Job Function ID

-

Responses

metrics

Get Prometheus metrics.

Get Prometheus metrics. +

path Parameters
id
required
integer

Task ID

+
wildcard
required
string

Content path

+
query Parameters
filter
string

Filter

+

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

+
path Parameters
id
required
integer

Bucket ID

+
wildcard
required
string

Content path

+

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

+
path Parameters
id
required
integer

Bucket ID

+
wildcard
required
string

Content path

+

Responses

businessservices

List all business services.

List all business services.

+

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Create a business service.

Create a business service.

+
Request Body schema: application/json

Business service data

+
createTime
string
createUser
string
description
string
id
integer
name
required
string
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Get a business service by ID.

Get a business service by ID.

+
path Parameters
id
required
integer

Business Service ID

+

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Update a business service.

Update a business service.

+
path Parameters
id
required
integer

Business service ID

+
Request Body schema: application/json

Business service data

+
createTime
string
createUser
string
description
string
id
integer
name
required
string
object (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "owner": {
    },
  • "updateUser": "string"
}

Delete a business service.

Delete a business service.

+
path Parameters
id
required
integer

Business service ID

+

Responses

cache

Delete a directory within the cache.

Delete a directory within the cache.

+

Responses

Get the cache.

Get the cache.

+
path Parameters
wildcard
required
string

Cache DIR

+

Responses

Response samples

Content type
application/json
{
  • "capacity": "string",
  • "exists": true,
  • "path": "string",
  • "used": "string"
}

file

List all files.

List all files.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a file.

Create a file.

+
path Parameters
name
required
string

File name

+

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "expiration": "string",
  • "id": 0,
  • "name": "string",
  • "path": "string",
  • "updateUser": "string"
}

Get a file by ID.

Get a file by ID. Returns api.File when Accept=application/json else the file content.

+
path Parameters
id
required
integer

File ID

+

Responses

Append a file.

Append a file.

+
path Parameters
id
required
integer

File ID

+

Responses

Delete a file.

Delete a file.

+
path Parameters
id
required
integer

File ID

+

Responses

identities

List all identities.

List all identities.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an identity.

Create an identity.

+
Request Body schema: application/json

Identity data

+
createTime
string
createUser
string
description
string
id
integer
key
string
kind
required
string
name
required
string
password
string
settings
string
updateUser
string
user
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Get an identity by ID.

Get an identity by ID.

+
path Parameters
id
required
integer

Identity ID

+

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Update an identity.

Update an identity.

+
path Parameters
id
required
integer

Identity ID

+
Request Body schema: application/json

Identity data

+
createTime
string
createUser
string
description
string
id
integer
key
string
kind
required
string
name
required
string
password
string
settings
string
updateUser
string
user
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "key": "string",
  • "kind": "string",
  • "name": "string",
  • "password": "string",
  • "settings": "string",
  • "updateUser": "string",
  • "user": "string"
}

Delete an identity.

Delete an identity.

+
path Parameters
id
required
integer

Identity ID

+

Responses

imports

List imports.

List imports.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an import by ID.

Get an import by ID.

+
path Parameters
id
required
integer

Import ID

+

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Delete an import.

Delete an import. This leaves any created application or dependency.

+
path Parameters
id
required
integer

Import ID

+

Responses

List import summaries.

List import summaries.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export the source CSV for a particular import summary.

Export the source CSV for a particular import summary.

+
query Parameters
importSummary.id
required
string

ImportSummary ID

+

Responses

Upload a CSV containing applications and dependencies to import.

Upload a CSV containing applications and dependencies to import.

+

Responses

Response samples

Content type
application/json
{
  • "createEntities": true,
  • "createTime": "string",
  • "createUser": "string",
  • "filename": "string",
  • "id": 0,
  • "importStatus": "string",
  • "importTime": "string",
  • "invalidCount": 0,
  • "updateUser": "string",
  • "validCount": 0
}

Get an import summary by ID.

Get an import by ID.

+
path Parameters
id
required
integer

ImportSummary ID

+

Responses

Response samples

Content type
application/json
{
  • "createEntities": true,
  • "createTime": "string",
  • "createUser": "string",
  • "filename": "string",
  • "id": 0,
  • "importStatus": "string",
  • "importTime": "string",
  • "invalidCount": 0,
  • "updateUser": "string",
  • "validCount": 0
}

Delete an import summary and associated import records.

Delete an import summary and associated import records.

+
path Parameters
id
required
integer

ImportSummary ID

+

Responses

jobfunctions

List all job functions.

List all job functions.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a job function.

Create a job function.

+
Request Body schema: application/json

Job Function data

+
createTime
string
createUser
string
id
integer
name
required
string
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Get a job function by ID.

Get a job function by ID.

+
path Parameters
id
required
integer

Job Function ID

+

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Update a job function.

Update a job function.

+
path Parameters
id
required
integer

Job Function ID

+
Request Body schema: application/json

Job Function data

+
createTime
string
createUser
string
id
integer
name
required
string
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Delete a job function.

Delete a job function.

+
path Parameters
id
required
integer

Job Function ID

+

Responses

metrics

Get Prometheus metrics.

Get Prometheus metrics. Wrapper for Prometheus-supplied handler. Served on port defined by METRICS_PORT environment variable.

-

Responses

migrationwaves

List all migration waves.

List all migration waves.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a migration wave.

Create a migration wave.

-
Request Body schema: application/json

Migration Wave data

-
Array of objects (api.Ref)
createTime
string
createUser
string
endDate
string
id
integer
name
string
Array of objects (api.Ref)
Array of objects (api.Ref)
startDate
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Get a migration wave by ID.

Get a migration wave by ID.

-
path Parameters
id
required
integer

Migration Wave ID

-

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Update a migration wave.

Update a migration wave.

-
path Parameters
id
required
integer

MigrationWave id

-
Request Body schema: application/json

MigrationWave data

-
Array of objects (api.Ref)
createTime
string
createUser
string
endDate
string
id
integer
name
string
Array of objects (api.Ref)
Array of objects (api.Ref)
startDate
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Delete a migration wave.

Delete a migration wave.

-
path Parameters
id
required
integer

MigrationWave id

-

Responses

proxies

List all proxies.

List all proxies.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an proxy.

Create an proxy.

-
Request Body schema: application/json

Proxy data

-
createTime
string
createUser
string
enabled
boolean
excluded
Array of strings
host
string
id
integer
object (api.Ref)
kind
string
Enum: "http" "https"
port
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Get an proxy by ID.

Get an proxy by ID.

-
path Parameters
id
required
integer

Proxy ID

-

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Update an proxy.

Update an proxy.

-
path Parameters
id
required
integer

Proxy ID

-
Request Body schema: application/json

Proxy data

-
createTime
string
createUser
string
enabled
boolean
excluded
Array of strings
host
string
id
integer
object (api.Ref)
kind
string
Enum: "http" "https"
port
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Delete an proxy.

Delete an proxy.

-
path Parameters
id
required
integer

Proxy ID

-

Responses

reviews

List all reviews.

List all reviews.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a review.

Create a review.

-
Request Body schema: application/json

Review data

-
object (api.Ref)
object (api.Ref)
businessCriticality
integer
comments
string
createTime
string
createUser
string
effortEstimate
string
id
integer
proposedAction
string
updateUser
string
workPriority
integer

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Copy a review from one application to others.

Copy a review from one application to others.

-
Request Body schema: application/json

Review copy request data

-
sourceReview
required
integer
targetApplications
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "sourceReview": 0,
  • "targetApplications": [
    ]
}

Get a review by ID.

Get a review by ID.

-
path Parameters
id
required
integer

Review ID

-

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Update a review.

Update a review.

-
path Parameters
id
required
integer

Review ID

-
Request Body schema: application/json

Review data

-
object (api.Ref)
object (api.Ref)
businessCriticality
integer
comments
string
createTime
string
createUser
string
effortEstimate
string
id
integer
proposedAction
string
updateUser
string
workPriority
integer

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Delete a review.

Delete a review.

-
path Parameters
id
required
integer

Review ID

-

Responses

rulesets

List all bindings.

List all bindings. +

Responses

migrationwaves

List all migration waves.

List all migration waves.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a migration wave.

Create a migration wave.

+
Request Body schema: application/json

Migration Wave data

+
Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
endDate
required
string
id
integer
name
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
startDate
required
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Get a migration wave by ID.

Get a migration wave by ID.

+
path Parameters
id
required
integer

Migration Wave ID

+

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Update a migration wave.

Update a migration wave.

+
path Parameters
id
required
integer

MigrationWave id

+
Request Body schema: application/json

MigrationWave data

+
Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
endDate
required
string
id
integer
name
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
startDate
required
string
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "endDate": "string",
  • "id": 0,
  • "name": "string",
  • "stakeholderGroups": [
    ],
  • "stakeholders": [
    ],
  • "startDate": "string",
  • "updateUser": "string"
}

Delete a migration wave.

Delete a migration wave.

+
path Parameters
id
required
integer

MigrationWave id

+

Responses

proxies

List all proxies.

List all proxies.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an proxy.

Create an proxy.

+
Request Body schema: application/json

Proxy data

+
createTime
string
createUser
string
enabled
boolean
excluded
Array of strings
host
string
id
integer
object (api.Ref)
kind
string
Enum: "http" "https"
port
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Get an proxy by ID.

Get an proxy by ID.

+
path Parameters
id
required
integer

Proxy ID

+

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Update an proxy.

Update an proxy.

+
path Parameters
id
required
integer

Proxy ID

+
Request Body schema: application/json

Proxy data

+
createTime
string
createUser
string
enabled
boolean
excluded
Array of strings
host
string
id
integer
object (api.Ref)
kind
string
Enum: "http" "https"
port
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "enabled": true,
  • "excluded": [
    ],
  • "host": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "http",
  • "port": 0,
  • "updateUser": "string"
}

Delete an proxy.

Delete an proxy.

+
path Parameters
id
required
integer

Proxy ID

+

Responses

reviews

List all reviews.

List all reviews.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a review.

Create a review.

+
Request Body schema: application/json

Review data

+
object (api.Ref)
object (api.Ref)
businessCriticality
integer
comments
string
createTime
string
createUser
string
effortEstimate
string
id
integer
proposedAction
string
updateUser
string
workPriority
integer

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Copy a review from one application to others.

Copy a review from one application to others.

+
Request Body schema: application/json

Review copy request data

+
sourceReview
required
integer
targetApplications
required
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "sourceReview": 0,
  • "targetApplications": [
    ]
}

Get a review by ID.

Get a review by ID.

+
path Parameters
id
required
integer

Review ID

+

Responses

Response samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Update a review.

Update a review.

+
path Parameters
id
required
integer

Review ID

+
Request Body schema: application/json

Review data

+
object (api.Ref)
object (api.Ref)
businessCriticality
integer
comments
string
createTime
string
createUser
string
effortEstimate
string
id
integer
proposedAction
string
updateUser
string
workPriority
integer

Responses

Request samples

Content type
application/json
{
  • "application": {
    },
  • "archetype": {
    },
  • "businessCriticality": 0,
  • "comments": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "effortEstimate": "string",
  • "id": 0,
  • "proposedAction": "string",
  • "updateUser": "string",
  • "workPriority": 0
}

Delete a review.

Delete a review.

+
path Parameters
id
required
integer

Review ID

+

Responses

rulesets

List all bindings.

List all bindings. filters:

  • name
  • labels
-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a ruleset.

Create a ruleset.

-
Request Body schema: application/json

RuleSet data

-
createTime
string
createUser
string
Array of objects (api.Ref)
description
string
id
integer
object (api.Ref)
kind
string
name
string
object (api.Repository)
Array of objects (api.Rule)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "dependsOn": [
    ],
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "dependsOn": [
    ],
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Get a RuleSet by ID.

Get a RuleSet by ID.

-
path Parameters
id
required
integer

RuleSet ID

-

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "dependsOn": [
    ],
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Update a ruleset.

Update a ruleset.

-
path Parameters
id
required
integer

RuleSet ID

-
Request Body schema: application/json

RuleSet data

-
createTime
string
createUser
string
Array of objects (api.Ref)
description
string
id
integer
object (api.Ref)
kind
string
name
string
object (api.Repository)
Array of objects (api.Rule)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "dependsOn": [
    ],
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Delete a ruleset.

Delete a ruleset.

-
path Parameters
id
required
integer

RuleSet ID

-

Responses

schema

Get the API schema.

Get the API schema.

-

Responses

Response samples

Content type
application/json
{
  • "paths": [
    ],
  • "version": "string"
}

settings

List all settings.

List all settings.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a setting.

Create a setting.

-
Request Body schema: application/json

Setting data

-
key
string
value
object

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Get a setting by its key.

Get a setting by its key.

-
path Parameters
key
required
string

Key

-

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Update a setting.

Update a setting.

-
path Parameters
key
required
string

Key

-

Responses

Create a setting.

Create a setting.

-
path Parameters
key
required
string

Key

-
Request Body schema: application/json

Setting value

-
key
string
value
object

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Delete a setting.

Delete a setting.

-
path Parameters
key
required
string

Key

-

Responses

stakeholdergroups

List all stakeholder groups.

List all stakeholder groups.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a stakeholder group.

Create a stakeholder group.

-
Request Body schema: application/json

Stakeholder Group data

-
createTime
string
createUser
string
description
string
id
integer
Array of objects (api.Ref)
name
required
string
Array of objects (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Get a stakeholder group by ID.

Get a stakeholder group by ID.

-
path Parameters
id
required
integer

Stakeholder Group ID

-

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Update a stakeholder group.

Update a stakeholder group.

-
path Parameters
id
required
integer

Stakeholder Group ID

-
Request Body schema: application/json

Stakeholder Group data

-
createTime
string
createUser
string
description
string
id
integer
Array of objects (api.Ref)
name
required
string
Array of objects (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Delete a stakeholder group.

Delete a stakeholder group.

-
path Parameters
id
required
integer

Stakeholder Group ID

-

Responses

stakeholders

List all stakeholders.

List all stakeholders.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a stakeholder.

Create a stakeholder.

-
Request Body schema: application/json

Stakeholder data

-
Array of objects (api.Ref)
Array of objects (api.Ref)
createTime
string
createUser
string
email
required
string
id
integer
object (api.Ref)
Array of objects (api.Ref)
name
required
string
Array of objects (api.Ref)
Array of objects (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Get a stakeholder by ID.

Get a stakeholder by ID.

-
path Parameters
id
required
integer

Stakeholder ID

-

Responses

Response samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Update a stakeholder.

Update a stakeholder.

-
path Parameters
id
required
integer

Stakeholder ID

-
Request Body schema: application/json

Stakeholder data

-
Array of objects (api.Ref)
Array of objects (api.Ref)
createTime
string
createUser
string
email
required
string
id
integer
object (api.Ref)
Array of objects (api.Ref)
name
required
string
Array of objects (api.Ref)
Array of objects (api.Ref)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Delete a stakeholder.

Delete a stakeholder.

-
path Parameters
id
required
integer

Stakeholder ID

-

Responses

tagcategories

List all tag categories.

List all tag categories.

-
query Parameters
name
string

Optional category name filter

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a tag category.

Create a tag category.

-
Request Body schema: application/json

Tag Category data

-
colour
string
createTime
string
createUser
string
id
integer
name
required
string
rank
integer
Array of objects (api.Ref)
updateUser
string
username
string

Responses

Request samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Get a tag category by ID.

Get a tag category by ID.

-
path Parameters
id
required
integer

Tag Category ID

-

Responses

Response samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Update a tag category.

Update a tag category.

-
path Parameters
id
required
integer

Tag Category ID

-
Request Body schema: application/json

Tag Category data

-
colour
string
createTime
string
createUser
string
id
integer
name
required
string
rank
integer
Array of objects (api.Ref)
updateUser
string
username
string

Responses

Request samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Delete a tag category.

Delete a tag category.

-
path Parameters
id
required
integer

Tag Category ID

-

Responses

List the tags in the tag category.

List the tags in the tag category.

-
path Parameters
id
required
integer

Tag Category ID

-
query Parameters
name
string

Optional tag name filter

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

targets

List all targets.

List all targets.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a target.

Create a target.

-
Request Body schema: application/json

Target data

-
choice
boolean
createTime
string
createUser
string
custom
boolean
description
string
id
integer
object (api.Ref)
Array of objects (api.Label)
name
string
provider
string
object (api.RuleSet)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Get a Target by ID.

Get a Target by ID.

-
path Parameters
id
required
integer

Target ID

-

Responses

Response samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Update a target.

Update a target.

-
path Parameters
id
required
integer

Target ID

-
Request Body schema: application/json

Target data

-
choice
boolean
createTime
string
createUser
string
custom
boolean
description
string
id
integer
object (api.Ref)
Array of objects (api.Label)
name
string
provider
string
object (api.RuleSet)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Delete a target.

Delete a target.

-
path Parameters
id
required
integer

Target ID

-

Responses

taskgroups

List all task groups.

List all task groups.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a task group.

Create a task group.

-
Request Body schema: application/json

TaskGroup data

-
addon
string
object (api.Ref)
createTime
string
createUser
string
data
required
object
id
integer
name
string
state
string
Array of objects (api.Task)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Get a task group by ID.

Get a task group by ID.

-
path Parameters
id
required
integer

TaskGroup ID

-

Responses

Response samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Update a task group.

Update a task group.

-
path Parameters
id
required
integer

Task ID

-
Request Body schema: application/json

Task data

-
addon
string
object (api.Ref)
createTime
string
createUser
string
data
required
object
id
integer
name
string
state
string
Array of objects (api.Task)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Delete a task group.

Delete a task group.

-
path Parameters
id
required
integer

TaskGroup ID

-

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. +

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a ruleset.

Create a ruleset.

+
Request Body schema: application/json

RuleSet data

+
createTime
string
createUser
string
Array of objects (api.Ref) [ items ]
description
string
id
integer
object (api.Ref)
kind
string
name
string
object (api.Repository)
Array of objects (api.Rule) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "dependsOn": [
    ],
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "dependsOn": [
    ],
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Get a RuleSet by ID.

Get a RuleSet by ID.

+
path Parameters
id
required
integer

RuleSet ID

+

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "dependsOn": [
    ],
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Update a ruleset.

Update a ruleset.

+
path Parameters
id
required
integer

RuleSet ID

+
Request Body schema: application/json

RuleSet data

+
createTime
string
createUser
string
Array of objects (api.Ref) [ items ]
description
string
id
integer
object (api.Ref)
kind
string
name
string
object (api.Repository)
Array of objects (api.Rule) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "dependsOn": [
    ],
  • "description": "string",
  • "id": 0,
  • "identity": {
    },
  • "kind": "string",
  • "name": "string",
  • "repository": {
    },
  • "rules": [
    ],
  • "updateUser": "string"
}

Delete a ruleset.

Delete a ruleset.

+
path Parameters
id
required
integer

RuleSet ID

+

Responses

schema

Get the API schema.

Get the API schema.

+

Responses

Response samples

Content type
application/json
{
  • "paths": [
    ],
  • "version": "string"
}

settings

List all settings.

List all settings.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a setting.

Create a setting.

+
Request Body schema: application/json

Setting data

+
key
string
value
object

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Get a setting by its key.

Get a setting by its key.

+
path Parameters
key
required
string

Key

+

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Update a setting.

Update a setting.

+
path Parameters
key
required
string

Key

+

Responses

Create a setting.

Create a setting.

+
path Parameters
key
required
string

Key

+
Request Body schema: application/json

Setting value

+
key
string
value
object

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Delete a setting.

Delete a setting.

+
path Parameters
key
required
string

Key

+

Responses

stakeholdergroups

List all stakeholder groups.

List all stakeholder groups.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a stakeholder group.

Create a stakeholder group.

+
Request Body schema: application/json

Stakeholder Group data

+
createTime
string
createUser
string
description
string
id
integer
Array of objects (api.Ref) [ items ]
name
required
string
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Get a stakeholder group by ID.

Get a stakeholder group by ID.

+
path Parameters
id
required
integer

Stakeholder Group ID

+

Responses

Response samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Update a stakeholder group.

Update a stakeholder group.

+
path Parameters
id
required
integer

Stakeholder Group ID

+
Request Body schema: application/json

Stakeholder Group data

+
createTime
string
createUser
string
description
string
id
integer
Array of objects (api.Ref) [ items ]
name
required
string
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "createTime": "string",
  • "createUser": "string",
  • "description": "string",
  • "id": 0,
  • "migrationWaves": [
    ],
  • "name": "string",
  • "stakeholders": [
    ],
  • "updateUser": "string"
}

Delete a stakeholder group.

Delete a stakeholder group.

+
path Parameters
id
required
integer

Stakeholder Group ID

+

Responses

stakeholders

List all stakeholders.

List all stakeholders.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a stakeholder.

Create a stakeholder.

+
Request Body schema: application/json

Stakeholder data

+
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
email
required
string
id
integer
object (api.Ref)
Array of objects (api.Ref) [ items ]
name
required
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Get a stakeholder by ID.

Get a stakeholder by ID.

+
path Parameters
id
required
integer

Stakeholder ID

+

Responses

Response samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Update a stakeholder.

Update a stakeholder.

+
path Parameters
id
required
integer

Stakeholder ID

+
Request Body schema: application/json

Stakeholder data

+
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
createTime
string
createUser
string
email
required
string
id
integer
object (api.Ref)
Array of objects (api.Ref) [ items ]
name
required
string
Array of objects (api.Ref) [ items ]
Array of objects (api.Ref) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "businessServices": [
    ],
  • "contributes": [
    ],
  • "createTime": "string",
  • "createUser": "string",
  • "email": "string",
  • "id": 0,
  • "jobFunction": {
    },
  • "migrationWaves": [
    ],
  • "name": "string",
  • "owns": [
    ],
  • "stakeholderGroups": [
    ],
  • "updateUser": "string"
}

Delete a stakeholder.

Delete a stakeholder.

+
path Parameters
id
required
integer

Stakeholder ID

+

Responses

tagcategories

List all tag categories.

List all tag categories.

+
query Parameters
name
string

Optional category name filter

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a tag category.

Create a tag category.

+
Request Body schema: application/json

Tag Category data

+
colour
string
createTime
string
createUser
string
id
integer
name
required
string
rank
integer
Array of objects (api.Ref) [ items ]
updateUser
string
username
string

Responses

Request samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Get a tag category by ID.

Get a tag category by ID.

+
path Parameters
id
required
integer

Tag Category ID

+

Responses

Response samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Update a tag category.

Update a tag category.

+
path Parameters
id
required
integer

Tag Category ID

+
Request Body schema: application/json

Tag Category data

+
colour
string
createTime
string
createUser
string
id
integer
name
required
string
rank
integer
Array of objects (api.Ref) [ items ]
updateUser
string
username
string

Responses

Request samples

Content type
application/json
{
  • "colour": "string",
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "name": "string",
  • "rank": 0,
  • "tags": [
    ],
  • "updateUser": "string",
  • "username": "string"
}

Delete a tag category.

Delete a tag category.

+
path Parameters
id
required
integer

Tag Category ID

+

Responses

List the tags in the tag category.

List the tags in the tag category.

+
path Parameters
id
required
integer

Tag Category ID

+
query Parameters
name
string

Optional tag name filter

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

targets

List all targets.

List all targets.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a target.

Create a target.

+
Request Body schema: application/json

Target data

+
choice
boolean
createTime
string
createUser
string
custom
boolean
description
string
id
integer
object (api.Ref)
Array of objects (api.Label) [ items ]
name
string
provider
string
object (api.RuleSet)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Get a Target by ID.

Get a Target by ID.

+
path Parameters
id
required
integer

Target ID

+

Responses

Response samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Update a target.

Update a target.

+
path Parameters
id
required
integer

Target ID

+
Request Body schema: application/json

Target data

+
choice
boolean
createTime
string
createUser
string
custom
boolean
description
string
id
integer
object (api.Ref)
Array of objects (api.Label) [ items ]
name
string
provider
string
object (api.RuleSet)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "choice": true,
  • "createTime": "string",
  • "createUser": "string",
  • "custom": true,
  • "description": "string",
  • "id": 0,
  • "image": {
    },
  • "labels": [
    ],
  • "name": "string",
  • "provider": "string",
  • "ruleset": {
    },
  • "updateUser": "string"
}

Delete a target.

Delete a target.

+
path Parameters
id
required
integer

Target ID

+

Responses

taskgroups

List all task groups.

List all task groups.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a task group.

Create a task group.

+
Request Body schema: application/json

TaskGroup data

+
addon
string
object (api.Ref)
createTime
string
createUser
string
data
required
object
extensions
Array of strings
id
integer
kind
string
name
string
object (api.TaskPolicy)
priority
integer
state
string
Array of objects (api.Task) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "extensions": [
    ],
  • "id": 0,
  • "kind": "string",
  • "name": "string",
  • "policy": {
    },
  • "priority": 0,
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "extensions": [
    ],
  • "id": 0,
  • "kind": "string",
  • "name": "string",
  • "policy": {
    },
  • "priority": 0,
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Get a task group by ID.

Get a task group by ID.

+
path Parameters
id
required
integer

TaskGroup ID

+

Responses

Response samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "extensions": [
    ],
  • "id": 0,
  • "kind": "string",
  • "name": "string",
  • "policy": {
    },
  • "priority": 0,
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Update a task group.

Update a task group.

+
path Parameters
id
required
integer

Task ID

+
Request Body schema: application/json

Task data

+
addon
string
object (api.Ref)
createTime
string
createUser
string
data
required
object
extensions
Array of strings
id
integer
kind
string
name
string
object (api.TaskPolicy)
priority
integer
state
string
Array of objects (api.Task) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "extensions": [
    ],
  • "id": 0,
  • "kind": "string",
  • "name": "string",
  • "policy": {
    },
  • "priority": 0,
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

Delete a task group.

Delete a task group.

+
path Parameters
id
required
integer

TaskGroup ID

+

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. Returns index.html for directories when Accept=text/html else a tarball. ?filter=glob supports directory content filtering.

-
path Parameters
id
required
integer

TaskGroup ID

-
wildcard
required
string

Content path

-
query Parameters
filter
string

Filter

-

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

-
path Parameters
id
required
integer

TaskGroup ID

-
wildcard
required
string

Content path

-

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

-
path Parameters
id
required
integer

Task ID

-
wildcard
required
string

Content path

-

Responses

Submit a task group.

Submit a task group.

-
path Parameters
id
required
integer

TaskGroup ID

-
Request Body schema: application/json

TaskGroup data (optional)

-
addon
string
object (api.Ref)
createTime
string
createUser
string
data
required
object
id
integer
name
string
state
string
Array of objects (api.Task)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

tasks

List all tasks.

List all tasks.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a task.

Create a task.

-
Request Body schema: application/json

Task data

-
activity
Array of strings
addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
Array of objects (api.TaskError)
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Get a task by ID.

Get a task by ID.

-
path Parameters
id
required
integer

Task ID

-

Responses

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Update a task.

Update a task.

-
path Parameters
id
required
integer

Task ID

-
Request Body schema: application/json

Task data

-
activity
Array of strings
addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
Array of objects (api.TaskError)
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

Delete a task.

Delete a task.

-
path Parameters
id
required
integer

Task ID

-

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. +

path Parameters
id
required
integer

TaskGroup ID

+
wildcard
required
string

Content path

+
query Parameters
filter
string

Filter

+

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

+
path Parameters
id
required
integer

TaskGroup ID

+
wildcard
required
string

Content path

+

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

+
path Parameters
id
required
integer

Task ID

+
wildcard
required
string

Content path

+

Responses

Submit a task group.

Patch and submit a task group.

+
path Parameters
id
required
integer

TaskGroup ID

+
Request Body schema: application/json

TaskGroup data (optional)

+
addon
string
object (api.Ref)
createTime
string
createUser
string
data
required
object
extensions
Array of strings
id
integer
kind
string
name
string
object (api.TaskPolicy)
priority
integer
state
string
Array of objects (api.Task) [ items ]
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "addon": "string",
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "extensions": [
    ],
  • "id": 0,
  • "kind": "string",
  • "name": "string",
  • "policy": {
    },
  • "priority": 0,
  • "state": "string",
  • "tasks": [
    ],
  • "updateUser": "string"
}

tasks

Queued queued task report.

Queued queued task report. +Filters:

+
    +
  • addon
    • +
+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a task.

Create a task.

+
Request Body schema: application/json

Task data

+
activity
Array of strings
addon
string
object (api.Ref)
Array of objects (api.Attachment) [ items ]
object (api.Ref)
createTime
string
createUser
string
data
object
Array of objects (api.TaskError) [ items ]
Array of objects (api.TaskEvent) [ items ]
extensions
Array of strings
id
integer
kind
string
locator
string
name
string
pod
string
object (api.TaskPolicy)
priority
integer
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "attached": [
    ],
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "events": [
    ],
  • "extensions": [
    ],
  • "id": 0,
  • "kind": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": {
    },
  • "priority": 0,
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "attached": [
    ],
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "events": [
    ],
  • "extensions": [
    ],
  • "id": 0,
  • "kind": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": {
    },
  • "priority": 0,
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string"
}

Get a task by ID.

Get a task by ID.

+
path Parameters
id
required
integer

Task ID

+

Responses

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "attached": [
    ],
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "events": [
    ],
  • "extensions": [
    ],
  • "id": 0,
  • "kind": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": {
    },
  • "priority": 0,
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string"
}

Update a task.

Update a task.

+
path Parameters
id
required
integer

Task ID

+
Request Body schema: application/json

Task data

+
activity
Array of strings
addon
string
object (api.Ref)
Array of objects (api.Attachment) [ items ]
object (api.Ref)
createTime
string
createUser
string
data
object
Array of objects (api.TaskError) [ items ]
Array of objects (api.TaskEvent) [ items ]
extensions
Array of strings
id
integer
kind
string
locator
string
name
string
pod
string
object (api.TaskPolicy)
priority
integer
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "attached": [
    ],
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "events": [
    ],
  • "extensions": [
    ],
  • "id": 0,
  • "kind": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": {
    },
  • "priority": 0,
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string"
}

Delete a task.

Delete a task.

+
path Parameters
id
required
integer

Task ID

+

Responses

Get attached files.

Get attached files. +Returns a tarball with attached files.

+
path Parameters
id
required
integer

Task ID

+

Responses

Get bucket content by ID and path.

Get bucket content by ID and path. Returns index.html for directories when Accept=text/html else a tarball. ?filter=glob supports directory content filtering.

-
path Parameters
id
required
integer

Task ID

-
wildcard
required
string

Content path

-
query Parameters
filter
string

Filter

-

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

-
path Parameters
id
required
integer

Task ID

-
wildcard
required
string

Content path

-

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

-
path Parameters
id
required
integer

Task ID

-
wildcard
required
string

Content path

-

Responses

Cancel a task.

Cancel a task.

-
path Parameters
id
required
integer

Task ID

-

Responses

Update a task report.

Update a task report.

-
path Parameters
id
required
integer

Task ID

-
Request Body schema: application/json

TaskReport data

-
activity
Array of strings
completed
integer
createTime
string
createUser
string
Array of objects (api.TaskError)
id
integer
result
object
status
string
task
integer
total
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Create a task report.

Update a task report.

-
path Parameters
id
required
integer

Task ID

-
Request Body schema: application/json

TaskReport data

-
activity
Array of strings
completed
integer
createTime
string
createUser
string
Array of objects (api.TaskError)
id
integer
result
object
status
string
task
integer
total
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Delete a task report.

Delete a task report.

-
path Parameters
id
required
integer

Task ID

-

Responses

Submit a task.

Submit a task.

-
path Parameters
id
required
integer

Task ID

-
Request Body schema: application/json

Task data (optional)

-
activity
Array of strings
addon
required
string
object (api.Ref)
object (api.Ref)
canceled
boolean
createTime
string
createUser
string
data
required
object
Array of objects (api.TaskError)
id
integer
image
string
locator
string
name
string
pod
string
policy
string
priority
integer
purged
boolean
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string
variant
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "bucket": {
    },
  • "canceled": true,
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "id": 0,
  • "image": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": "string",
  • "priority": 0,
  • "purged": true,
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string",
  • "variant": "string"
}

trackers

List all trackers.

List all trackers.

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a tracker.

Create a tracker.

-
Request Body schema: application/json

Tracker data

-
connected
boolean
createTime
string
createUser
string
id
integer
required
object (api.Ref)
insecure
boolean
kind
required
string
Enum: "jira-cloud" "jira-onprem"
lastUpdated
string
message
string
name
required
string
updateUser
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Get a tracker by ID.

Get a tracker by ID.

-
path Parameters
id
required
integer

Tracker ID

-

Responses

Response samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Update a tracker.

Update a tracker.

-
path Parameters
id
required
integer

Tracker id

-
Request Body schema: application/json

Tracker data

-
connected
boolean
createTime
string
createUser
string
id
integer
required
object (api.Ref)
insecure
boolean
kind
required
string
Enum: "jira-cloud" "jira-onprem"
lastUpdated
string
message
string
name
required
string
updateUser
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Delete a tracker.

Delete a tracker.

-
path Parameters
id
required
integer

Tracker id

-

Responses

List a tracker's projects.

List a tracker's projects.

-
path Parameters
id
required
integer

Tracker ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a tracker project by ID.

Get a tracker project by ID.

-
path Parameters
id
required
integer

Tracker ID

-
id2
required
string

Project ID

-

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

List a tracker project's issue types.

List a tracker project's issue types.

-
path Parameters
id
required
integer

Tracker ID

-
id2
required
string

Project ID

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]
+
path Parameters
id
required
integer

Task ID

+
wildcard
required
string

Content path

+
query Parameters
filter
string

Filter

+

Responses

Upload bucket content by ID and path.

Upload bucket content by ID and path (handles both [post] and [put] requests).

+
path Parameters
id
required
integer

Task ID

+
wildcard
required
string

Content path

+

Responses

Delete bucket content by ID and path.

Delete bucket content by ID and path.

+
path Parameters
id
required
integer

Task ID

+
wildcard
required
string

Content path

+

Responses

Cancel a task.

Cancel a task.

+
path Parameters
id
required
integer

Task ID

+

Responses

Update a task report.

Update a task report.

+
path Parameters
id
required
integer

Task ID

+
Request Body schema: application/json

TaskReport data

+
activity
Array of strings
Array of objects (api.Attachment) [ items ]
completed
integer
createTime
string
createUser
string
Array of objects (api.TaskError) [ items ]
id
integer
result
object
status
string
task
integer
total
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "attached": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Create a task report.

Update a task report.

+
path Parameters
id
required
integer

Task ID

+
Request Body schema: application/json

TaskReport data

+
activity
Array of strings
Array of objects (api.Attachment) [ items ]
completed
integer
createTime
string
createUser
string
Array of objects (api.TaskError) [ items ]
id
integer
result
object
status
string
task
integer
total
integer
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "attached": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "attached": [
    ],
  • "completed": 0,
  • "createTime": "string",
  • "createUser": "string",
  • "errors": [
    ],
  • "id": 0,
  • "result": { },
  • "status": "string",
  • "task": 0,
  • "total": 0,
  • "updateUser": "string"
}

Delete a task report.

Delete a task report.

+
path Parameters
id
required
integer

Task ID

+

Responses

Submit a task.

Patch and submit a task.

+
path Parameters
id
required
integer

Task ID

+
Request Body schema: application/json

Task data (optional)

+
activity
Array of strings
addon
string
object (api.Ref)
Array of objects (api.Attachment) [ items ]
object (api.Ref)
createTime
string
createUser
string
data
object
Array of objects (api.TaskError) [ items ]
Array of objects (api.TaskEvent) [ items ]
extensions
Array of strings
id
integer
kind
string
locator
string
name
string
pod
string
object (api.TaskPolicy)
priority
integer
retries
integer
started
string
state
string
terminated
string
object (api.TTL)
updateUser
string

Responses

Request samples

Content type
application/json
{
  • "activity": [
    ],
  • "addon": "string",
  • "application": {
    },
  • "attached": [
    ],
  • "bucket": {
    },
  • "createTime": "string",
  • "createUser": "string",
  • "data": { },
  • "errors": [
    ],
  • "events": [
    ],
  • "extensions": [
    ],
  • "id": 0,
  • "kind": "string",
  • "locator": "string",
  • "name": "string",
  • "pod": "string",
  • "policy": {
    },
  • "priority": 0,
  • "retries": 0,
  • "started": "string",
  • "state": "string",
  • "terminated": "string",
  • "ttl": {
    },
  • "updateUser": "string"
}

trackers

List all trackers.

List all trackers.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a tracker.

Create a tracker.

+
Request Body schema: application/json

Tracker data

+
connected
boolean
createTime
string
createUser
string
id
integer
required
object (api.Ref)
insecure
boolean
kind
required
string
Enum: "jira-cloud" "jira-onprem"
lastUpdated
string
message
string
name
required
string
updateUser
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Get a tracker by ID.

Get a tracker by ID.

+
path Parameters
id
required
integer

Tracker ID

+

Responses

Response samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Update a tracker.

Update a tracker.

+
path Parameters
id
required
integer

Tracker id

+
Request Body schema: application/json

Tracker data

+
connected
boolean
createTime
string
createUser
string
id
integer
required
object (api.Ref)
insecure
boolean
kind
required
string
Enum: "jira-cloud" "jira-onprem"
lastUpdated
string
message
string
name
required
string
updateUser
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "connected": true,
  • "createTime": "string",
  • "createUser": "string",
  • "id": 0,
  • "identity": {
    },
  • "insecure": true,
  • "kind": "jira-cloud",
  • "lastUpdated": "string",
  • "message": "string",
  • "name": "string",
  • "updateUser": "string",
  • "url": "string"
}

Delete a tracker.

Delete a tracker.

+
path Parameters
id
required
integer

Tracker id

+

Responses

List a tracker's projects.

List a tracker's projects.

+
path Parameters
id
required
integer

Tracker ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a tracker project by ID.

Get a tracker project by ID.

+
path Parameters
id
required
integer

Tracker ID

+
id2
required
string

Project ID

+

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

List a tracker project's issue types.

List a tracker project's issue types.

+
path Parameters
id
required
integer

Tracker ID

+
id2
required
string

Project ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]