Profiles

Get a profile

Retrieve a profile by ID

get/v1/profiles/{id}

Path parameters

idstring uuid required

Query parameters

projectIdstring uuid

Project to query profiles from

Response

Default Response

createdAtstring date-time required

The date and time when the profile was created

{"stackTrail":"components:schemas:Profile:properties:credentialsConfig","oasType":"schema","type":"unknown","description":"The credentials configuration associated with the profile","nullable":true}
extensionIdsstring[] nullable required

The extension IDs associated with the profile

idstring uuid required

The unique identifier for the profile

projectIdstring uuid nullable required

The project ID associated with the profile

sourceSessionIdstring uuid nullable required

The last session ID associated with the profile

status'UPLOADING' | 'READY' | 'FAILED' required

The status of the profile

updatedAtstring date-time required

The date and time when the profile was last updated

{"stackTrail":"components:schemas:Profile:properties:useProxyConfig","oasType":"schema","type":"unknown","description":"The proxy configuration associated with the profile","nullable":true}
userAgentstring nullable required

The user agent associated with the profile

Changes

Changed in 4 of the 54 revisions of this API.116

    • added the new optional query request parameter projectId

      new-optional-request-parameter

    • added the optional property linkToDocs to the response with the 400 status

      response-optional-property-added

    • added the optional property linkToDocs to the response with the 404 status

      response-optional-property-added

    • added the optional property linkToDocs to the response with the 500 status

      response-optional-property-added

    • added the required property projectId to the response with the 200 status

      response-required-property-added

    • removed the DELETED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • added the new DELETED enum value to the status response property for the response status 200

      response-property-enum-value-added

    • the response property context/items/params became required for the status 400

      response-property-became-required

    • the response property context/items/params became required for the status 404

      response-property-became-required

    • the response property context/items/params became required for the status 500

      response-property-became-required

    • the response property credentialsConfig became required for the status 200

      response-property-became-required

    • the response property useProxyConfig became required for the status 200

      response-property-became-required

    • the createdAt response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ was added for the status 200

      response-property-pattern-added

    • the id response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ was added for the status 200

      response-property-pattern-added

    • the sourceSessionId response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ was added for the status 200

      response-property-pattern-added

    • the updatedAt response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ was added for the status 200

      response-property-pattern-added

    • endpoint added

      endpoint-added