REST API로 통합
SDK가 없거나 별도 HTTP 클라이언트를 사용하는 환경에서는 REST API로 workflow를 실행할 수 있어요.
실행 API 주소는 https://api.deplite.io/v1/run/{agentName}/{workflowName} ;이에요.
1. 토큰 발급
콘솔에서 대상 workflow 화면을 열고 workflow 권한 토큰을 발급해주세요.
평문 토큰은 발급 직후 한 번만 표시되므로 안전한 곳에 보관해주세요.
2. 첫 호출
Agent와 workflow 이름은 path에 넣기 전에 URL 인코딩해주세요.
아래 예제는 wait: true로 결과를 기다리고, 성공이 아닌 status를 실패 처리해요.
예제에는 jq가 필요해요.
export DEPLITE_API_TOKEN='dpl_...'
AGENT_NAME='my-agent'
WORKFLOW_NAME='deploy'
agent_name=$(jq -rn --arg value "$AGENT_NAME" '$value | @uri')
workflow_name=$(jq -rn --arg value "$WORKFLOW_NAME" '$value | @uri')
response=$(curl --fail-with-body -sS -X POST "https://api.deplite.io/v1/run/$agent_name/$workflow_name" -H "Authorization: Bearer $DEPLITE_API_TOKEN" -H "Content-Type: application/json" -d '{"ref":"main","wait":true}')
status=$(jq -r '.status' <<< "$response")
if [ "$status" != "success" ]; then
echo "$response"
exit 1
fi비동기로 요청하면 response의 consoleUrl에서 실행 결과를 확인할 수 있어요.
비동기 실행 응답의 jobId를 같은 API Token으로 GET /v1/jobs/{jobId}에 보내면 상태를 조회할 수 있어요.
로그는 GET /v1/jobs/{jobId}/logs로 조회해주세요. 자세한 내용은 잡 조회 API를 참고해주세요.
관련 문서
최종 수정 일자: