logo
Documentation Powered by ReDoc

KubeSphere (2.0.2)

Download OpenAPI specification:Download

kubesphere: kubesphere@yunify.com URL: https://kubesphere.io License: Apache

KubeSphere OpenAPI

> Read Notification API documents.

Authentication

jwt

Security scheme type: API Key
Header parameter name: Authorization

DevOps Project

Get the specified DevOps Project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "create_time": "2022-10-13T07:56:32Z",
  • "creator": "string",
  • "description": "string",
  • "extra": "string",
  • "name": "string",
  • "project_id": "string",
  • "status": "string",
  • "visibility": "string",
  • "workspace": "string"
}

Update the specified DevOps Project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

Request Body schema: application/json
create_time
required
string <date-time>

DevOps Project's Creation time'

creator
required
string

Creator's username'

description
string

DevOps Projects's Description, used to describe the DevOps Project'

extra
string

Internal Use

name
required
string

DevOps Projects's Name

project_id
required
string

ProjectId must be unique within a workspace, it is generated by kubesphere.

status
required
string

DevOps project's status. e.g. active

visibility
string

Desperated Field

workspace
required
string

The workspace to which the devops project belongs

Responses

200

ok

patch /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "create_time": "2022-10-13T07:56:32Z",
  • "creator": "string",
  • "description": "string",
  • "extra": "string",
  • "name": "string",
  • "project_id": "string",
  • "status": "string",
  • "visibility": "string",
  • "workspace": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "create_time": "2022-10-13T07:56:32Z",
  • "creator": "string",
  • "description": "string",
  • "extra": "string",
  • "name": "string",
  • "project_id": "string",
  • "status": "string",
  • "visibility": "string",
  • "workspace": "string"
}

DevOps Project Credential

Get all credentials of the specified DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/credentials
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/credentials

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create a credential in the specified DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

Request Body schema: application/json
create_time
string <date-time>

Credential's create_time'

creator
string

Creator's username

description
string

Credential's description'

display_name
string

Credential's display name'

domain
string

Credential's domain,In ks we only use the default domain, default '_''

fingerprint
object (devops.JenkinsCredential.fingerprint)
id
required
string

Id of Credential, e.g. dockerhub-id

kubeconfig
object (devops.KubeconfigCredential)
secret_text
object (devops.SecretTextCredential)
ssh
object (devops.SshCredential)
type
required
string

Type of Credential, e.g. ssh/kubeconfig

username_password
object (devops.UsernamePasswordCredential)

Responses

200

OK

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/credentials
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/credentials

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "create_time": "2022-10-13T07:56:32Z",
  • "creator": "string",
  • "description": "string",
  • "display_name": "string",
  • "domain": "string",
  • "fingerprint":
    {
    },
  • "id": "string",
  • "kubeconfig":
    {
    },
  • "secret_text":
    {
    },
  • "ssh":
    {
    },
  • "type": "string",
  • "username_password":
    {
    }
}

Get the specified credential of the DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

credential
required
string

credential's ID, e.g. dockerhub-id

query Parameters
content
string

Get extra credential content if this query parameter is set. Specifically, there are three types of info in a credential. One is the basic info that must be returned for each query such as name, id, etc. The second one is non-encrypted info such as the username of the username-password type of credential, which returns when the "content" parameter is set to non-empty. The last one is encrypted info, such as the password of the username-password type of credential, which never returns.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/credentials/{credential}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/credentials/{credential}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "create_time": "2022-10-13T07:56:32Z",
  • "creator": "string",
  • "description": "string",
  • "display_name": "string",
  • "domain": "string",
  • "fingerprint":
    {
    },
  • "id": "string",
  • "kubeconfig":
    {
    },
  • "secret_text":
    {
    },
  • "ssh":
    {
    },
  • "type": "string",
  • "username_password":
    {
    }
}

Update the specified credential of the DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

credential
required
string

credential's ID, e.g. dockerhub-id

Request Body schema: application/json
create_time
string <date-time>

Credential's create_time'

creator
string

Creator's username

description
string

Credential's description'

display_name
string

Credential's display name'

domain
string

Credential's domain,In ks we only use the default domain, default '_''

fingerprint
object (devops.JenkinsCredential.fingerprint)
id
required
string

Id of Credential, e.g. dockerhub-id

kubeconfig
object (devops.KubeconfigCredential)
secret_text
object (devops.SecretTextCredential)
ssh
object (devops.SshCredential)
type
required
string

Type of Credential, e.g. ssh/kubeconfig

username_password
object (devops.UsernamePasswordCredential)

Responses

200

OK

put /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/credentials/{credential}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/credentials/{credential}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "create_time": "2022-10-13T07:56:32Z",
  • "creator": "string",
  • "description": "string",
  • "display_name": "string",
  • "domain": "string",
  • "fingerprint":
    {
    },
  • "id": "string",
  • "kubeconfig":
    {
    },
  • "secret_text":
    {
    },
  • "ssh":
    {
    },
  • "type": "string",
  • "username_password":
    {
    }
}

Delete the specified credential of the DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

credential
required
string

credential's ID, e.g. dockerhub-id

Responses

200

OK

delete /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/credentials/{credential}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/credentials/{credential}

DevOps Pipeline

Get crumb issuer. A CrumbIssuer represents an algorithm to generate a nonce value, known as a crumb, to counter cross site request forgery exploits. Crumbs are typically hashes incorporating information that uniquely identifies an agent that sends a request, along with a guarded secret so that the crumb value cannot be forged by a third party.

Authorizations:
jwt

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/crumbissuer
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/crumbissuer

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "crumb": "string",
  • "crumbRequestField": "string"
}

Create a DevOps project pipeline

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

Request Body schema: application/json
multi_branch_pipeline
object (devops.MultiBranchPipeline)
pipeline
object (devops.NoScmPipeline)
type
required
string

type of devops pipeline, in scm or no scm

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "multi_branch_pipeline":
    {
    },
  • "pipeline":
    {
    },
  • "type": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "multi_branch_pipeline":
    {
    },
  • "pipeline":
    {
    },
  • "type": "string"
}

Get the specified pipeline of the DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "_links":
    {
    },
  • "actions":
    [
    ],
  • "branchNames":
    [
    ],
  • "disabled": null,
  • "displayName": "string",
  • "estimatedDurationInMillis": 0,
  • "fullDisplayName": "string",
  • "fullName": "string",
  • "name": "string",
  • "numberOfFailingBranches": 0,
  • "numberOfFailingPullRequests": 0,
  • "numberOfFolders": 0,
  • "numberOfPipelines": 0,
  • "numberOfSuccessfulBranches": 0,
  • "numberOfSuccessfulPullRequests": 0,
  • "organization": "string",
  • "parameters": null,
  • "permissions":
    {
    },
  • "pipelineFolderNames":
    [
    ],
  • "scmSource":
    {
    },
  • "totalNumberOfBranches": 0,
  • "totalNumberOfPullRequests": 0,
  • "weatherScore": 0
}

Update the specified pipeline of the DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, e.g. sample-pipeline

Request Body schema: application/json
multi_branch_pipeline
object (devops.MultiBranchPipeline)
pipeline
object (devops.NoScmPipeline)
type
required
string

type of devops pipeline, in scm or no scm

Responses

200

OK

put /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "multi_branch_pipeline":
    {
    },
  • "pipeline":
    {
    },
  • "type": "string"
}

Delete the specified pipeline of the DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, e.g. sample-pipeline

Responses

200

OK

delete /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}

(MultiBranchesPipeline) Get all branches in the specified pipeline.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

query Parameters
filter
string <filter=%s>

filter remote scm. e.g. origin

start
string <start=%d>
Default: "start=0"

the count of branches start.

limit
string <limit=%d>
Default: "limit=100"

the count of branches limit.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

(MultiBranchesPipeline) Get all activities in the specified pipeline.

Authorizations:
jwt
path Parameters
devops
required
string

the name of devops project

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "_links":
    {
    },
  • "actions":
    [
    ],
  • "branch":
    {
    },
  • "disabled": true,
  • "displayName": "string",
  • "estimatedDurationInMillis": 0,
  • "fullDisplayName": "string",
  • "fullName": "string",
  • "latestRun":
    {
    },
  • "name": "string",
  • "organization": "string",
  • "parameters":
    [
    ],
  • "permissions":
    {
    },
  • "weatherScore": 0
}

(MultiBranchesPipeline) Run pipeline.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

Request Body schema: application/json
parameters
Array of objects (devops.RunPayload.parameters)

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "parameters":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "_links":
    {
    },
  • "actions":
    [
    ],
  • "artifactsZipFile": null,
  • "causeOfBlockage": "string",
  • "causes":
    [
    ],
  • "changeSet":
    [
    ],
  • "description": null,
  • "durationInMillis": null,
  • "enQueueTime": null,
  • "endTime": null,
  • "estimatedDurationInMillis": null,
  • "id": "string",
  • "name": null,
  • "organization": "string",
  • "pipeline": "string",
  • "queueId": "string",
  • "replayable": true,
  • "result": "string",
  • "runSummary": null,
  • "startTime": null,
  • "state": "string",
  • "type": "string"
}

(MultiBranchesPipeline) Get all runs in a branch

Authorizations:
jwt
path Parameters
pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "_links":
    {
    },
  • "actions":
    [
    ],
  • "artifactsZipFile": null,
  • "branch":
    {
    },
  • "causeOfBlockage": null,
  • "causes":
    [
    ],
  • "changeSet":
    [
    ],
  • "commitId": "string",
  • "commitUrl": null,
  • "description": null,
  • "durationInMillis": 0,
  • "enQueueTime": "string",
  • "endTime": "string",
  • "estimatedDurationInMillis": 0,
  • "id": "string",
  • "name": null,
  • "organization": "string",
  • "pipeline": "string",
  • "pullRequest": null,
  • "replayable": true,
  • "result": "string",
  • "runSummary": "string",
  • "startTime": "string",
  • "state": "string",
  • "type": "string"
}

(MultiBranchesPipeline) Get all artifacts in the specified pipeline.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

query Parameters
start
string <start=%d>

the item number of the search starts from.

limit
string <limit=%d>

the limit item count of the search.

Responses

200

The filed of "Url" in response can download artifacts

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/artifacts
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/artifacts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

(MultiBranchesPipeline) Get run logs of the specified pipeline activity.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

query Parameters
start
string <start=%d>
Default: "start=0"

the item number of the search starts from.

Responses

200

OK

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/log
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/log

(MultiBranchesPipeline) Get run nodes.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

query Parameters
limit
string <limit=%d>
Default: "limit=10000"

the limit item count of the search.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/nodes
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/nodes

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

(MultiBranchesPipeline) Get all steps in the specified node.

Authorizations:
jwt
path Parameters
devops
required
string

the name of devops project

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

node
required
string

pipeline node id, the one node in pipeline.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/nodes/{node}/steps
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/nodes/{node}/steps

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

(MultiBranchesPipeline) Proceed or Break the paused pipeline which waiting for user input.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

node
required
string

pipeline node id, the one node in pipeline.

step
required
string

pipeline step id, the one step in pipeline.

Request Body schema: application/json
abort
boolean

abort or not

id
string

id

parameters
Array of objects (devops.CheckPlayload.parameters)

Responses

200

OK

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/nodes/{node}/steps/{step}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/nodes/{node}/steps/{step}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "abort": true,
  • "id": "string",
  • "parameters":
    [
    ]
}

(MultiBranchesPipeline) Get pipelines step log.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

node
required
string

pipeline node id, the one node in pipeline.

step
required
string

pipeline step id, the one step in pipeline.

query Parameters
start
string <start=%d>
Default: "start=0"

the item number of the search starts from.

Responses

200

OK

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/nodes/{node}/steps/{step}/log
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/nodes/{node}/steps/{step}/log

(MultiBranchesPipeline) Gives steps details inside a activity node. For a node, the steps which defined inside the node.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/nodesdetail
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/nodesdetail

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

(MultiBranchesPipeline) Replay pipeline

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/replay
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/replay

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "_links":
    {
    },
  • "actions":
    [
    ],
  • "artifactsZipFile": null,
  • "causeOfBlockage": "string",
  • "causes":
    [
    ],
  • "changeSet":
    [
    ],
  • "description": null,
  • "durationInMillis": null,
  • "enQueueTime": null,
  • "endTime": null,
  • "estimatedDurationInMillis": null,
  • "id": "string",
  • "name": null,
  • "organization": "string",
  • "pipeline": "string",
  • "queueId": "string",
  • "replayable": true,
  • "result": "string",
  • "runSummary": null,
  • "startTime": null,
  • "state": "string",
  • "type": "string"
}

(MultiBranchesPipeline) Stop pipeline.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

query Parameters
blocking
string <blocking=%t>
Default: "blocking=false"

stop and between each retries will sleep.

timeOutInSecs
string <timeOutInSecs=%d>
Default: "timeOutInSecs=10"

the time of stop and between each retries sleep.

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/stop
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/runs/{run}/stop

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "_links":
    {
    },
  • "actions":
    [
    ],
  • "artifactsZipFile": null,
  • "branch":
    {
    },
  • "causeOfBlockage": null,
  • "causes":
    [
    ],
  • "changeSet":
    [
    ],
  • "commitId": "string",
  • "commitUrl": null,
  • "description": null,
  • "durationInMillis": 0,
  • "enQueueTime": "string",
  • "endTime": "string",
  • "estimatedDurationInMillis": 0,
  • "id": "string",
  • "name": null,
  • "organization": "string",
  • "pipeline": "string",
  • "pullRequest": null,
  • "replayable": true,
  • "result": "string",
  • "runSummary": "string",
  • "startTime": "string",
  • "state": "string",
  • "type": "string"
}

Get the sonar quality check information for the specified pipeline branch of the DevOps project. For a detailed explanation of the fields you can refer to the official sonarqube documentation: https://docs.sonarqube.org/7.4/user-guide/metric-definitions/

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, e.g. sample-pipeline

branch
required
string

branch name, e.g. master

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/sonarstatus
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/branches/{branch}/sonarstatus

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the configuration information of the specified pipeline of the DevOps Project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, e.g. sample-pipeline

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/config
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/config

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "multi_branch_pipeline":
    {
    },
  • "pipeline":
    {
    },
  • "type": "string"
}

Get scan reponsitory logs in the specified pipeline.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

Responses

200

OK

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/consolelog
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/consolelog

Get all runs of the specified pipeline

Authorizations:
jwt
path Parameters
pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

query Parameters
start
string <start=%d>

the item number of the search starts from

limit
string <limit=%d>

the limit item count of the search

branch
string <branch=%s>

the name of branch, same as repository branch, will be filtered by branch.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Run pipeline.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

Request Body schema: application/json
parameters
Array of objects (devops.RunPayload.parameters)

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "parameters":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "_links":
    {
    },
  • "actions":
    [
    ],
  • "artifactsZipFile": null,
  • "causeOfBlockage": "string",
  • "causes":
    [
    ],
  • "changeSet":
    [
    ],
  • "description": null,
  • "durationInMillis": null,
  • "enQueueTime": null,
  • "endTime": null,
  • "estimatedDurationInMillis": null,
  • "id": "string",
  • "name": null,
  • "organization": "string",
  • "pipeline": "string",
  • "queueId": "string",
  • "replayable": true,
  • "result": "string",
  • "runSummary": null,
  • "startTime": null,
  • "state": "string",
  • "type": "string"
}

Get all activities in the specified pipeline.

Authorizations:
jwt
path Parameters
devops
required
string

the name of devops project

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

run
required
string

pipeline run id, the unique id for a pipeline once build.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "_links":
    {
    },
  • "actions":
    [
    ],
  • "artifactsZipFile": null,
  • "branch": null,
  • "causeOfBlockage": null,
  • "causes":
    [
    ],
  • "changeSet":
    [
    ],
  • "commitId": null,
  • "commitUrl": null,
  • "description": null,
  • "durationInMillis": 0,
  • "enQueueTime": "string",
  • "endTime": "string",
  • "estimatedDurationInMillis": 0,
  • "id": "string",
  • "name": null,
  • "organization": "string",
  • "pipeline": "string",
  • "pullRequest": null,
  • "replayable": true,
  • "result": "string",
  • "runSummary": "string",
  • "startTime": "string",
  • "state": "string",
  • "type": "string"
}

Get all artifacts in the specified pipeline.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

run
required
string

pipeline run id, the unique id for a pipeline once build.

query Parameters
start
string <start=%d>

the item number of the search starts from.

limit
string <limit=%d>

the limit item count of the search.

Responses

200

The filed of "Url" in response can download artifacts

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/artifacts
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/artifacts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get run logs of the specified pipeline activity.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

run
required
string

pipeline run id, the unique id for a pipeline once build.

query Parameters
start
string <start=%d>
Default: "start=0"

the item number of the search starts from.

Responses

200

OK

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/log
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/log

Get all nodes in the specified activity. node is the stage in the pipeline task

Authorizations:
jwt
path Parameters
devops
required
string

the name of devops project

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

run
required
string

pipeline run id, the unique id for a pipeline once build

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/nodes
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/nodes

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get all steps in the specified node.

Authorizations:
jwt
path Parameters
devops
required
string

the name of devops project

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

run
required
string

pipeline run id, the unique id for a pipeline once build

node
required
string

pipeline node id, the one node in pipeline.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Proceed or Break the paused pipeline which waiting for user input.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

run
required
string

pipeline run id, the unique id for a pipeline once build.

node
required
string

pipeline node id, the one node in pipeline.

step
required
string

pipeline step id

Request Body schema: application/json
abort
boolean

abort or not

id
string

id

parameters
Array of objects (devops.CheckPlayload.parameters)

Responses

200

OK

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "abort": true,
  • "id": "string",
  • "parameters":
    [
    ]
}

Get pipelines step log.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

run
required
string

pipeline run id, the unique id for a pipeline once build.

node
required
string

pipeline node id, the one node in pipeline.

step
required
string

pipeline step id, the one step in pipeline.

query Parameters
start
string <start=%d>
Default: "start=0"

the item number of the search starts from.

Responses

200

OK

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}/log
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}/log

Gives steps details inside a activity node. For a node, the steps which defined inside the node.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

branch
required
string

the name of branch, same as repository brnach.

run
required
string

pipeline run id, the unique id for a pipeline once build.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/nodesdetail
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/nodesdetail

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Replay pipeline

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

run
required
string

pipeline run id, the unique id for a pipeline once build.

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/replay
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/replay

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "_links":
    {
    },
  • "actions":
    [
    ],
  • "artifactsZipFile": null,
  • "causeOfBlockage": "string",
  • "causes":
    [
    ],
  • "changeSet":
    [
    ],
  • "description": null,
  • "durationInMillis": null,
  • "enQueueTime": null,
  • "endTime": null,
  • "estimatedDurationInMillis": null,
  • "id": "string",
  • "name": null,
  • "organization": "string",
  • "pipeline": "string",
  • "queueId": "string",
  • "replayable": true,
  • "result": "string",
  • "runSummary": null,
  • "startTime": null,
  • "state": "string",
  • "type": "string"
}

Stop pipeline

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

run
required
string

pipeline run id, the unique id for a pipeline once build.

query Parameters
blocking
string <blocking=%t>
Default: "blocking=false"

stop and between each retries will sleep.

timeOutInSecs
string <timeOutInSecs=%d>
Default: "timeOutInSecs=10"

the time of stop and between each retries sleep.

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/stop
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/runs/{run}/stop

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "_class": "string",
  • "_links":
    {
    },
  • "actions":
    [
    ],
  • "artifactsZipFile": null,
  • "branch":
    {
    },
  • "causeOfBlockage": null,
  • "causes":
    [
    ],
  • "changeSet":
    [
    ],
  • "commitId": "string",
  • "commitUrl": null,
  • "description": null,
  • "durationInMillis": 0,
  • "enQueueTime": "string",
  • "endTime": "string",
  • "estimatedDurationInMillis": 0,
  • "id": "string",
  • "name": null,
  • "organization": "string",
  • "pipeline": "string",
  • "pullRequest": null,
  • "replayable": true,
  • "result": "string",
  • "runSummary": "string",
  • "startTime": "string",
  • "state": "string",
  • "type": "string"
}

Scan remote Repositorie, Start a build if have new branch.

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, which helps to deliver continuous integration continuous deployment.

query Parameters
delay
string <delay=%d>

will be delay time to scan.

Responses

200

OK

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/scan
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/scan

Get the sonar quality information for the specified pipeline of the DevOps project. For a detailed explanation of the fields you can refer to the official sonarqube documentation: https://docs.sonarqube.org/7.4/user-guide/metric-definitions/

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

pipeline
required
string

the name of pipeline, e.g. sample-pipeline

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/sonarstatus
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/pipelines/{pipeline}/sonarstatus

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Search DevOps resource.

Authorizations:
jwt
query Parameters
q
string <q=%s>

query pipelines, condition for filtering.

filter
string <filter=%s>

Filter some types of jobs. e.g. no-folder，will not get a job of type folder

start
string <start=%d>

the item number of the search starts from.

limit
string <limit=%d>

the limit item count of the search.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/search
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/search

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

DevOps Project Member

Get the build-in roles info of the specified DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/defaultroles
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/defaultroles

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the members of the specified DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

query Parameters
paging
string <limit=%d,page=%d>
Default: "limit=10,page=1"

page

conditions
string <key=%s,key~%s>

query conditions, support using key-value pairs separated by comma to search, like 'conditions:somekey=somevalue,anotherkey=anothervalue'

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/members
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/members

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Add a member to the specified DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/members
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/members

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "grand_by": "string",
  • "project_id": "string",
  • "role": "string",
  • "status": "string",
  • "username": "string"
}

Get the specified member of the DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

member
required
string

member's username, e.g. admin

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/members/{member}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/members/{member}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "grand_by": "string",
  • "project_id": "string",
  • "role": "string",
  • "status": "string",
  • "username": "string"
}

Delete the specified member of the DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

member
required
string

member's username, e.g. admin

Responses

200

OK

delete /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/members/{member}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/members/{member}

Update the specified member of the DevOps project

Authorizations:
jwt
path Parameters
devops
required
string

DevOps project's ID, e.g. project-RRRRAzLBlLEm

member
required
string

member's username, e.g. admin

Request Body schema: application/json
grand_by
string

Username of the user who assigned the role

project_id
required
string

the DevOps Projects which project membership belongs to

role
required
string

DevOps Project membership's role type. e.g. owner '

status
required
string

Desperated, Status of project membership. e.g. active

username
required
string

Member's username，username can uniquely identify a user

Responses

200

ok

patch /kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/members/{member}
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/devops/{devops}/members/{member}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "grand_by": "string",
  • "project_id": "string",
  • "role": "string",
  • "status": "string",
  • "username": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "grand_by": "string",
  • "project_id": "string",
  • "role": "string",
  • "status": "string",
  • "username": "string"
}

DevOps Webhook

Get commit notification by HTTP GET method. Git webhook will request here.

Authorizations:
jwt
query Parameters
url
required
string <url=%s>

url of git

Responses

200

OK

get /kapis/devops.kubesphere.io/v1alpha2/webhook/git
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/webhook/git

Get commit notification by HTTP POST method. Git webhook will request here.

Authorizations:
jwt
query Parameters
url
required
string <url=%s>

url of git

Responses

200

OK

post /kapis/devops.kubesphere.io/v1alpha2/webhook/git
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/webhook/git

Get commit notification. Github webhook will request here.

Authorizations:
jwt

Responses

200

OK

post /kapis/devops.kubesphere.io/v1alpha2/webhook/github
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/webhook/github

DevOps Jenkinsfile

Convert json to jenkinsfile format.

Authorizations:
jwt
Request Body schema: application/x-www-form-urlencoded
json
string

json data

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/tojenkinsfile
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/tojenkinsfile

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "status": "string"
}

Convert jenkinsfile to json format. Usually the frontend uses json to show or edit pipeline

Authorizations:
jwt
Request Body schema: application/x-www-form-urlencoded
jenkinsfile
string

jenkinsfile

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/tojson
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/tojson

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "status": "string"
}

DevOps Scm

List all organizations of the specified source configuration management (SCM) such as Github.

Authorizations:
jwt
path Parameters
scm
required
string

the id of the source configuration management (SCM).

query Parameters
credentialId
required
string <credentialId=%s>

credential id for source configuration management (SCM).

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/scms/{scm}/organizations
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/scms/{scm}/organizations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

List all repositories in the specified organization.

Authorizations:
jwt
path Parameters
scm
required
string

The id of the source configuration management (SCM).

organization
required
string

organization Id, such as github username.

query Parameters
credentialId
required
string <credentialId=%s>

credential id for SCM.

pageNumber
required
string <pageNumber=%d>

page number.

pageSize
required
string <pageSize=%d>

the item count of one page.

Responses

200

ok

get /kapis/devops.kubesphere.io/v1alpha2/scms/{scm}/organizations/{organization}/repositories
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/scms/{scm}/organizations/{organization}/repositories

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Validate the access token of the specified source configuration management (SCM) such as Github

Authorizations:
jwt
path Parameters
scm
required
string

the id of the source configuration management (SCM).

Responses

200

ok

post /kapis/devops.kubesphere.io/v1alpha2/scms/{scm}/verify
https://console.kubesphere.io/kapis/devops.kubesphere.io/v1alpha2/scms/{scm}/verify

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "credentialId": "string"
}

Identity Management

TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

Authorizations:
jwt
Request Body schema: application/json
apiVersion
required
string

Kubernetes API version

kind
required
string

kind of the API object

spec
object (iam.Spec)
status
object (iam.Status)

Responses

200

ok

post /kapis/iam.kubesphere.io/v1alpha2/authenticate
https://console.kubesphere.io/kapis/iam.kubesphere.io/v1alpha2/authenticate

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apiVersion": "string",
  • "kind": "string",
  • "spec":
    {
    },
  • "status":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apiVersion": "string",
  • "kind": "string",
  • "spec":
    {
    },
  • "status":
    {
    }
}

KubeSphere APIs support token-based authentication via the Authtoken request header. The POST Login API is used to retrieve the authentication token. After the authentication token is obtained, it must be inserted into the Authtoken header for all requests.

Authorizations:
jwt
Request Body schema: application/json