Download OpenAPI specification:Download
This is the VoltBuilder API specification. You need to have a Pro account or better to use this API. You can request credentials at https://volt.build/plan/
The VoltBuilder API uses OAuth 2.0 client credential authentication. A bearer token is granted via the authenticate endpoint. The token is passed in the HTTP Authorization header, as documented in the OAuth 2 specification.
| Security Scheme Type | OAuth2 |
|---|---|
| clientCredentials OAuth Flow | Token URL: https://api.volt.build/v1/authenticate Scopes: |
This endpoint retrieves the status of the last submitted build as JSON.
curl --request GET \ --url https://api.volt.build/v1/app \ --header 'authorization: Bearer REPLACE_BEARER_TOKEN'
{- "status": "Completed",
- "timestamp": 1599670881,
- "name": "MyApp",
- "links": {
}
}| platform required | string Enum: "ios" "android" |
| app required | string <binary> |
curl --request POST \ --url https://api.volt.build/v1/app \ --header 'authorization: Bearer REPLACE_BEARER_TOKEN' \ --form platform=ios \ --form 'app=@app.zip;type=application/zip'
This is an OAuth2 compatible endpoint that allows you to request an access token for the API using your client credentials.
| grant_type required | string must be |
| client_id required | string <uuid> a uuid that represents your client |
| client_secret required | string a client secret (password) assigned to your client_id |
grant_type=client_credentials&client_id=a75fe631-6aae-4a75-869c-77efdbaae524&client_secret=JejqCteCsZXQVPhDNPGKJ6QM
{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "token_type": "bearer",
- "expires_in": 3600
}