Praecise Cloud/ Reference/ Projects

Start a deploy of the project from its source

post/api/projects/{name}/deploy

Start a deploy of the project from its source. Answers at once with a job; follow it at /api/projects/{name}/deploys/{id}. One deploy runs at a time.

Before you call

Credential
Authorization: Bearer $KEY with deploy
Scope
deploy
Role
member

Parameters

  • namestringrequired
    In the path. The project's name.
  • Idempotency-Keystring
    Header. Send the same key when retrying. Within 24 hours the first successful answer is returned again, with Idempotent-Replayed: true, instead of running twice.

Responses

  • 202application/json
    The deploy has started.

    object

  • 400application/json
    The request is not valid: a bad parameter, or a release that is not kept. Code bad_request or bad_release.
    • errorstringrequired
    • codestringrequired
  • 401application/json
    No token, or the token is unknown, revoked or expired. Code unauthenticated, token_revoked or token_expired.
    • errorstringrequired
    • codestringrequired
  • 403application/json
    The token lacks the scope, the call is not open to tokens, or the caller is not an owner. Code scope_missing, session_required or owner_required.
    • errorstringrequired
    • codestringrequired
  • 404application/json
    No such project, or one the caller cannot see. The two are not told apart. Code not_found.
    • errorstringrequired
    • codestringrequired
  • 409application/json
    A deploy is already running for the project, or the first request with this Idempotency-Key has not finished. Code deploy_running, no_source or request_in_progress.
    • errorstringrequired
    • codestringrequired
  • 422application/json
    The Idempotency-Key was already used for a different request. Code idempotency_key_reused.
    • errorstringrequired
    • codestringrequired
  • 429application/json
    Too many requests for this token. Retry-After says how many seconds to wait. Code rate_limited.
    • errorstringrequired
    • codestringrequired

This page as Markdown