Versions Compared

Version Old Version 12 New Version 13
Changes made by

Todd Barczak

Todd Barczak

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URL

METHOD

DESCRIPTION

Scope

Access

DATA

RESPONSE

/api/v1/pipeline/run

POST

Triggers a run operation on the pipeline which returns the status, a message and the run count for the new run.

API Access

Pipeline Access

Item RBAC

Code Block
{
    "pipelineId":"5fd56d90979ee048ee660624"
}
Code Block
{
    "status": "executed",
    "message": "Run pipeline request submitted successfully for (5fd56d90979ee048ee660624)",
    "runCount": 2
}

OR

Code Block
{
    "status": "failed",
    "message": "Pipeline 5fd56d90979ee048ee660624 is currently in a paused state.  Will not start another job until this pending status is resolved."
}

/api/v1/pipeline/status

POST

Gets the status of a pipeline based on the run count. So this can work against the current run or prior runs from a historical perspective.

API Access

Pipeline Access

Pipeline Logs (Read Only)

Item RBAC

Code Block
{
    "pipelineId":"5fd56d90979ee048ee660624",
    "runCount": 3
}

Code Block
{
    "status": "success",
    "message": "Pipeline: Blank Template's Run 3 was successful."
}

/api/v1/pipeline/reset

POST

Resets the pipeline to the beginning, clearing out any current run data.

API Access

Pipeline Access

Item RBAC

Code Block
{
    "pipelineId":"5fd56d90979ee048ee660624"
}

Code Block
    "status": "success",
    "message": "The pipeline run status has been reset."
}

/api/v1/pipeline/stop

POST

Stops a running pipeline. This action will post a stop operation to kafka for supported tools, but the pipeline job will finish it’s current operaiton and then shut down. This is not a hard stop operation.

API Access

Pipeline Access

Item RBAC

Code Block
{
    "pipelineId":"5fd56d90979ee048ee660624"
}

Code Block
{
    "status": "success",
    "message": "The pipeline has been stopped."
}

/api/v1/pipeline/summary

POST

Gets the pipeline data by ID

API Access

Pipeline Access

Item RBAC

Code Block
{
    "pipelineId":"5fd56d90979ee048ee660624"
}

Returns full JSON data object of pipeline.

/api/v1/pipeline/logs

POST

Gets pipeline activity logs. Optional runCount can be passed as integer. Data is limited to a max of 1000 records and is always sorted by most recent activity first.

The “type” property of the POST body is optional. If that exact string “console output” is passed, it will restrict the logs being returned to the console log activity for that given run.

API Access

Pipeline Access

Pipeline Logs (Read Only)

Item RBAC

Code Block
{
    "pipelineId":"5fd56d90979ee048ee660624",
    "runCount": 2,
    "type":"console output" //optional value
}

Array of pipeline activity logs.

/api/v1/registry/tools

GET

Gets the list of all tools (with all JSON data) that they have access to.

API Access

Tool Registry Access

Power User Role

n/a

Returns an array of tool objects in JSON format

/api/v1/registry/summary

POST

Gets a tool registry JSON object with ALL data about that tool by ID.

API Access

Tool Registry Access

Item RBAC

Code Block
{
    "toolId":"5fc7a12ebed9dd3a622f5d22"
}

Returns the full tool object in JSON format.

/api/v1/registry/update

POST

Passes a tool registry ID and then the data object properties of that tool in JSON that you wish to update. This can be as much or as little of the root JSON object as long as the data structure is preserved. It’s advised not to send the “_id” but it isn’t going to break things. Same with the createdAt or updatedAt. This allows for strategic updates of just the root properties of the pipeline data object or the whole thing.

API Access

Tool Registry Access

Item RBAC

Code Block
{
    "toolId":"5fd56d90979ee048ee660624",
    "tool": {
        "name":"Updated Tool Name Via CLI",
        "description": "Updating the description here through customer API.  Fingers crossed"
    }
}

Returns the updated tool object in JSON format

/api/v1/pipeline/pipelines

GET

Gets the list of all pipelines (with all JSON data) the user token has access to

API Access

Pipeline Access

Power User Role

n/a

Returns an array of pipeline objects in JSON format

/api/v1/logs/user/actions

GET

Gets the User Activity Logs for the system. This is a route limited to Site Admins and Power users and requires a token of either API scope or Security Logs scope.

If no date parameter is passed, the last 7 days of logs will be returned (up to a max of 1000 records)

API Access

Security Logs (Read Only)

Power User Role

Optional Query Parameters:

?date=YYYY-MM-DD

?type=<value from type field>

?count=<integer, number of records>

Code Block
{
    "count": 6,
    "data": [
        {
            "_id": "61042540e1d666c9ded178c4",
            "user_id": "5e1cbf251c26d68f7ce6361e",
            "user_email": "support@opsera.io",
            "type": "pipeline",
            "action": "update",
            "target_id": "5fbe589a0fae8b021e137534",
            "account": "org-opsera-dnd-acc0",
            "createdAt": "2021-07-30T16:13:52.109Z",
            "updatedAt": "2021-07-30T16:13:52.109Z",
            "__v": 0
        },
  ]
}

/api/v1/logs/user/tokens

GET

Gets the Personal Access Tokens' Activity Logs. This is a route limited to Site Admins and Power users and requires a token of either API scope or Security Logs scope.

If no date parameter is passed, the last 7 days will be returned.(up to a max of 1000 records)

API Access

Security Logs (Read Only)

Power User Role

Optional Query Parameters:

?date=YYYY-MM-DD

?scope=<value from scope field>

Code Block
{
    "count": 6,
    "data": [
        {
            "_id": "61057f3a1429a35336563240",
            "token_id": "61043b2bbcb6d95b55adc5fd",
            "scope": "api",
            "target": "/v1/logs/user/tokens",
            "user_id": "5e1cbf251c26d68f7ce6361e",
            "account": "org-opsera-dnd-acc0",
            "createdAt": "2021-07-31T16:50:02.242Z",
            "updatedAt": "2021-07-31T16:50:02.242Z",
            "__v": 0
        },
  ]
}