Skip to content

Commit

Permalink
Update transfer commitment documentation
Browse files Browse the repository at this point in the history
Respects the movement of the transfer token as queryString into the header
  • Loading branch information
VoigtS committed Mar 19, 2024
1 parent fc307ae commit 7765102
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/users/api-spec-resources.md
Expand Up @@ -773,9 +773,11 @@ The response is a JSON of the commitment including the following fields that ide
}
}
```
### POST /v1/domains/:id/projects/:id/transfer-commitment/:id?token=:token
### POST /v1/domains/:id/projects/:id/transfer-commitment/:id
Transfers the commitment from a source project to a target project.
Requires a project-admin token.
Requires a transfer token in the request header:
`Transfer-Token: [value]`.
This endpoint receives the target project ID, but the commitment ID from the source project.
Requires a generated token from the API: `/v1/domains/:id/projects/:id/commitments/:id/start-transfer`.
On success the API clears the `transfer_token` and `transfer_status` from the commitment.
Expand Down

0 comments on commit 7765102

Please sign in to comment.