Overview

In addition to supporting Zadig Basic version API , it also provides more API support to help developers connect to internal enterprise systems. If you need more, please contact the official(opens new window) for more support.

# API Call Method

Step 1: Get it API Token

Click the user in the upper right corner, select Account Settings in the menu, and copy API Token

API Token

Step 2: Call API

In the requested HTTP Header, add the specified Authorization information, and you can call the Zadig API in the HTTP Client. The example is as follows:

Tip: yours.zadig.com in the example is Zadig The system access address, please replace it according to the actual situation before requesting.

curl -H 'Authorization: Bearer your-token' http://yours.zadig.com/api/aslan/system/notification/subscribe

# API Overview

# Project

API Function Description	API Links
Create an empty project	POST /openapi/projects/project
Create a YAML project and initialize it	POST /openapi/projects/project/init/yaml
Create a Helm project and initialize it	POST /openapi/projects/project/init/helm
Get the project list	GET /openapi/projects/project
Get the specified project details	GET /openapi/projects/project/detail
Delete the project	DELETE /openapi/projects/project

# Workflow

Module	API Function Description	API Links
Workflow	Get a workflow list	GET /openapi/workflows
	Get workflow details	GET /openapi/workflows/custom/:workflowKey/detail
	Get a workflow task list	GET /openapi/workflows/custom/:workflowName/tasks
	Get workflow task details	GET /openapi/workflows/custom/task
	Execute the Workflow	POST /openapi/workflows/custom/task
	Cancel workflow tasks	DELETE /openapi/workflows/custom/task
	Retry the workflow task	POST /openapi/workflows/custom/:workflowName/task/:taskID
	Approval workflow	POST /openapi/workflows/custom/task/approve
	Create a workflow	POST /api/aslan/workflow/v4
	Update workflow	PUT /api/aslan/workflow/v4/:name
	Delete workflow	DELETE /openapi/workflows/custom
Workflow View	Get a workflow view list	GET /openapi/workflows/view
	Create a workflow view	POST /openapi/workflows/view
	Edit workflow view	PUT /openapi/workflows/view/:viewName
	Delete the workflow view	DELETE /openapi/workflows/view/:viewName

# Environment

Module	API Function Description	API Links
Environment addition, deletion, modification and inspection	View the environment list	Test environment: GET /openapi/environments Production environment: GET /openapi/environments/production
	View environment details	Test environment: GET /openapi/environments/:envName Production environment: GET /openapi/environments/production/:envName
	View environmental service details	Test environment: GET /openapi/environments/:envName/services/:serviceName Production environment: GET /openapi/environments/production/:envName/services/:serviceName
	View Environment K8S Service Yaml	Test: GET /openapi/environments/services/yaml Production: GET /openapi/environments/production/services/yaml
	View Environment Helm Service Values	Test: GET /openapi/environments/service/values Production: GET /openapi/environments/production/service/values
	New Environment - K8s YAML Project	Test environment: POST /openapi/environments Production environment: POST /openapi/environments/production
	New Environment - Helm Chart Project	POST /openapi/environments/helm
	Editing environment	Test environment: PUT /openapi/environments/:envName Production environment: PUT /openapi/environments/production/:envName
	Delete Environment	Test environment: DELETE /openapi/environments/:envName Production environment: DELETE /openapi/environments/production/:envName
	List events	GET /openapi/environments/kube/events
Manage Services	Add Service - K8s YAML Project	Test environment: POST /openapi/environments/service/yaml Production environment: POST /openapi/environments/production/service/yaml
	Add Service - Helm Chart Project	POST /openapi/environments/helm/:envName/services
	Update Service	Test environment: PUT /openapi/environments/service/yaml Production environment: PUT /openapi/environments/production/service/yaml
	Delete Service	Test environment: DELETE /openapi/environments/service/yaml Production environment: DELETE /openapi/environments/production/service/yaml
Environment Configuration	Add environment configuration	Test environment: POST /openapi/environments/:envName/envcfgs Production environment: POST /openapi/environments/production/:envName/envcfgs
	View the environment configuration list	Test environment: GET /openapi/environments/:envName/envcfgs Production environment: GET /openapi/environments/production/:envName/envcfgs
	View environment configuration details	Test environment: GET /openapi/environments/:envName/envcfg/:envCfgName Production environment: GET /openapi/environments/production/:envName/envcfg/:envCfgName
	Update environment configuration	PUT /openapi/environments/envcfgs
	Delete the environment configuration	Test environment: DELETE /openapi/environments/:envName/envcfg/:envCfgName Production environment: DELETE /openapi/environments/production/:envName/envcfg/:envCfgName
Global Variables	View global variables	Test environment: GET /openapi/environments/:envName/variable Production environment: GET /openapi/environments/production/:envName/variable
	Update Global Variables	Test environment: PUT /openapi/environments/:envName/variable Production environment: PUT /openapi/environments/production/:envName/variable
Service examples	Adjust the number of copies	POST /openapi/environments/scale
	Restart the service instance	Test environment: POST /openapi/environments/:envName/service/:serviceName/restart Production environment: POST /openapi/environments/production/:envName/service/:serviceName/restart
Update the image	Update Deployment Image	POST /openapi/environments/image/deployment/:envName
	Update Statefulset image	POST /openapi/environments/image/statefulset/:envName
	Update Cronjob image	POST /openapi/environments/image/cronjob/:envName
Sub-environment	Check the K8S Service of Workload	GET /openapi/environments/:envName/check/workloads/k8sservices
	Turn on sub-environment	POST /openapi/environments/:envName/share/enable
	Close the sub-environment	DELETE /openapi/environments/:envName/share/enable
	Check sub-environment Ready	GET /openapi/environments/:name/check/sharenv/:op/ready
	Get portal services	GET /openapi/environments/:name/share/portal/:serviceName
	Set up portal service	POST /openapi/environments/:name/share/portal/:serviceName
log	View container real-time logs	GET /openapi/logs/sse/pods/:podName/containers/:containerName

# Service

API Function Description	API Links
Get a list of services	Testing Service: GET /openapi/service/yaml/services Production Services: GET /openapi/service/yaml/production/services
Get service details	Testing Service: GET /openapi/service/yaml/:serviceName Production Services: GET /openapi/service/yaml/production/:serviceName
Create a new service (using templates)	Testing Service: POST /openapi/service/template/load/yaml Production Services: POST /openapi/service/template/production/load/yaml
Create a new service (manual input)	Testing Service: POST /openapi/service/yaml/raw Production Services: POST /openapi/service/yaml/production/raw
Update service configuration	Testing Service: PUT /openapi/service/yaml/:serviceName Production Services: PUT /openapi/service/yaml/production/:serviceName
Update Service Variables	Testing Service: PUT /openapi/service/yaml/:serviceName/variable Production Services: PUT /openapi/service/yaml/production/:serviceName/variable
Delete Service	Testing Service: DELETE /openapi/service/yaml/:serviceName Production Services: DELETE /openapi/service/yaml/production/:serviceName
Create Helm Service from Template	POST /openapi/service/template/load/helm

# Build

API Function Description	API Links
Create Build	POST /openapi/build
Update Build	PUT /openapi/build
Create a build using a build template	POST /openapi/build?source=template
Update Build from Template	PUT /openapi/build/:buildName/template
Query build list	GET /openapi/build
Get build details	GET /openapi/build/:buildName/detail
Delete the build	DELETE /openapi/build

# Test

API Function Description	API Links
Perform test tasks	POST /openapi/quality/testing/task
Get test task details	GET /openapi/quality/testing/:testName/task/:taskID

# Code scanning

API Function Description	API Links
Create a code scan	POST /openapi/quality/codescan
Execute code scanning tasks	POST /openapi/quality/codescan/:scanName/task
Get code scanning task details	GET /openapi/quality/codescan/:scanName/task/:taskID

# Version Management

API Function Description	API Links
List versions	GET /openapi/delivery/releases
Get version details	GET /openapi/delivery/releases/:id
Delete the version	DELETE /openapi/delivery/releases/:id
K8s YAML project creation version	POST /openapi/delivery/releases/k8s
Helm Chart Project Creation Version	POST /openapi/delivery/releases/helm
Retry Create Release	POST /openapi/delivery/releases/retry

# Release Plan

API Function Description	API Links
Create a release plan	POST /openapi/release_plan/v1
Get a list of release plans	GET /openapi/release_plan/v1
Get release plan details	GET /openapi/release_plan/v1/:id
Update Release Plan and Jobs	PATCH /openapi/release_plan/v1/:id

# Artifact Management

API Function Description	API Links
Get the version list	GET /api/aslan/delivery/releases

# Cluster

API Function Description	API Links
List cluster information	GET /openapi/system/cluster
Create a cluster	POST /openapi/system/cluster
Update the specified cluster	PUT /openapi/system/cluster/:id
Delete the specified cluster	DELETE /openapi/system/cluster/:id
Check the cluster Istio installation	GET /openapi/cluster/istio/check/:id

# Image Registry

API Function Description	API Links
Integrated image registry	POST /openapi/system/registry
List image registry information	GET /openapi/system/registry
Get the specified image registry information	GET /openapi/system/registry/:id
Update the specified image registry information	PUT /openapi/system/registry/:id

# Performance Insights

API Function Description	API Links
Data Overview	GET /openapi/statistics/overview
Building data statistics	GET /openapi/statistics/build
Deployment data statistics	GET /openapi/statistics/deploy
Test data statistics	GET /openapi/statistics/test
Data statistics for production environment release	GET /openapi/statistics/v2/release

# Users and Permissions

API Function Description	API Links
List user information	GET /openapi/users
List user group information	GET /openapi/user-groups
List project permission definitions	GET /openapi/policy/resource-actions
List role information	GET /openapi/policy/roles
Get character details	GET /openapi/policy/roles/:name
Create a project role	POST /openapi/policy/roles
Edit project roles	PUT /openapi/policy/roles/:name
Delete project roles	DELETE /openapi/policy/roles/:name
List project members	GET /openapi/policy/role-bindings
Add project members	POST /openapi/policy/role-bindings
Update project member permissions	POST /openapi/policy/role-bindings/user/:uid
Delete project members	DELETE /openapi/policy/role-bindings/user/:uid
Update project user group permissions	POST /openapi/policy/role-bindings/group/:gid
Delete project user group members	DELETE /openapi/policy/role-bindings/group/:gid
Delete user	DELETE /openapi/users/:uid

# Collaboration Mode

API Function Description	API Links
Create Collaboration Mode	POST /openapi/collaborations
Delete Collaboration Mode	DELETE /openapi/collaborations/:name

# System

API Function Description	API Links
List system operation logs	GET /openapi/system/operation
List environment operation logs	GET /openapi/system/operation/env

← Lark Project PluginProject→

本页导航