POST
/
{workspaceId}
/
projects
/
{projectName}
/
auth-sessions
/
{authSessionId}
/
update

Authorizations

​
x-api-key
string
headerrequired

API Key used to authenticate your requests. How to create one.

Path Parameters

​
workspaceId
string
required

Your workspace ID. How to find it?

​
projectName
string
required

Your project name. It is the name you provide when creating a project.

​
authSessionId
string
required

Authentication session ID. You can obtain it from the Auth Sessions tab in your project details.

Body

application/json

Auth session create request

​
id
string
required

Auth session id.

​
parameters

Auth session parameters

​
proxy
string

Proxy URL following this format http://username:password@domain:port

Response

201 - application/json
​
status
enum<string>
required
Available options:
started
​
operationId
string
required

Operation ID for the auth session creation. This is used in the resume and result operations.

Create Auth Session - ResumeUpdate Auth Session - Result