Remote Integration Agents

Get All Remote Agents

This endpoint retrieves a list of remote agent resources.

GET /api/v2/remote-agent/

GET /api/v2/remote-agent/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [
        {
            "id": 1,
            "name": "My Remote Agent",
            "creator": 1,
            "version": "v1.0",
            "platform": "Mac",
            "last_sync": "2019-03-01T05:00:00Z"
        }
    ]
}

Expand Parameters

See the Expand Parameters section for more details.

Parameter Description
creator Creator field is expanded to display information about the remote agent creator. 
GET /api/v2/remote-agent/?expand=creator HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "My Remote Agent",
    "creator": {
        "id": 1,
        "email": "admin@example.com",
        "first_name": "Admin",
        "last_name": "Testerton",
        "last_login": "2019-03-05T12:21:51.808717-05:00",
        "date_joined": "2011-05-25T11:37:55-04:00",
        "is_active": true,
        "is_superuser": true,
        "role": {
            "id": "UR4",
            "name": "Administrator"
        },
        "groups": [],
        "password_reset_in_progress": false
    },
    "version": "v1.0",
    "platform": "Mac",
    "last_sync": "2019-03-01T05:00:00Z"
}

Get a Specific Remote Agent

This endpoint retrieves a specific archived Remote Agent resource as specified by the id parameter.

GET /api/v2/remote-agent/{remote_agent_id}/

URL Parameters

Parameter Description
remote_agent_id The id of the Project to retrieve. 
GET /api/v2/remote-agent/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "My Remote Agent",
    "creator": 1,
    "version": "v1.0",
    "platform": "Mac",
    "last_sync": "2019-03-01T05:00:00Z"
}

Update a Remote Agent

Update a remote agent by setting the name, version, or platform PATCH /api/v2/remote-agent/{remote_agent_id}/

URL Parameters

Parameter Description
remote_agent_id The id of the Remote Agent to update.

Payload

Fields Required Description
name No The given name of remote agent.
version No The version of the remote agent.
platform No The platform the remote agent can run on. 
PATCH /api/v2/remote-agent/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "name": "Bob's agent",
    "version": "v2.0",
    "platform": "Linux"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "Bob's agent",
    "creator": 1,
    "version": "v2.0",
    "platform": "Linux",
    "last_sync": "2019-03-01T05:00:00Z"
}

Delete a Remote Agent

This endpoint deletes a specific remote agent specified by the agent id.

DELETE /api/v2/remote-agent/{remote_agent_id}/

URL Parameters

Parameter Description
remote_agent_id The id of the Remote Agent to delete. 
DELETE /api/v2/remote-agent/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 204 NO CONTENT

results matching ""

    No results matching ""