Skip to content

REST API

Endpoint

/v1/platform/properties

GET

Request
Parameters
Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation

/v1/platform/tenant

GET

Request
Parameters
Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation TenantResponse

/v1/puncher/dissect

POST

Request

Content-Type: multipart/mixed, multipart/form-data

Parameters
file file
Name Located in Required Description Schema
input formData yes
pattern formData yes
Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation

/v1/puncher/grok

POST

Request

Content-Type: multipart/mixed, multipart/form-data

Parameters
file file
Name Located in Required Description Schema
input formData yes
pattern formData yes
Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation

/v1/puncher/punchlet

POST

Request

Content-Type: multipart/*

Parameters
file file
Name Located in Required Description Schema
input formData yes
logFile formData yes
Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation

/v1/{tenant}/archives

DELETE

Delete all archive for a tenant

Request
Parameters
string
Name Located in Required Description Schema
tenant path yes Tenant name
Response
Status Code Reason Response Model
default successful operation -

/v1/{tenant}/archives/{id}

GET

Download an archive

Request
Parameters
string string
Name Located in Required Description Schema
tenant path yes Tenant name
id path yes Archive id
Response

Content-Type: application/zip

Status Code Reason Response Model
200 Successful download Resource
404 archive not found -

DELETE

Delete an archive

Request
Parameters
string string
Name Located in Required Description Schema
tenant path yes Tenant name
id path yes Archive id
Response
Status Code Reason Response Model
204 -
404 archive not found -

/v1/{tenant}/channels

GET

Request
Parameters
string
Name Located in Required Description Schema
tenant path yes
Response
Status Code Reason Response Model
200 successful operation

/v1/{tenant}/channels/{channel}

GET

Request
Parameters
string string
Name Located in Required Description Schema
tenant path yes
channel path yes
Response
Status Code Reason Response Model
200 successful operation PunchCtlChannelStatusResponse

/v1/{tenant}/channels/{channel}/start

POST

Request
Parameters
string string
Name Located in Required Description Schema
tenant path yes
channel path yes
Response
Status Code Reason Response Model
201 -

/v1/{tenant}/channels/{channel}/stop

POST

Request
Parameters
string string
Name Located in Required Description Schema
tenant path yes
channel path yes
Response
Status Code Reason Response Model
204 -

/v1/{tenant}/conf

GET

Request
Parameters
string
Name Located in Required Description Schema
tenant path yes
Response
Status Code Reason Response Model
200 successful operation

/v1/{tenant}/conf/**

GET

Request
Parameters
string
Name Located in Required Description Schema
tenant path yes
Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation

/v1/{tenant}/extraction

POST

Request

Content-Type: application/json

Parameters
string
Name Located in Required Description Schema
tenant path yes
body body no ExtractionRequest
Response

Content-Type: application/json

Status Code Reason Response Model
default successful operation -

/v1/{tenant}/punchline

POST

Request
Parameters
string file
Name Located in Required Description Schema
tenant path yes
file formData yes
Response
Status Code Reason Response Model
200 successful operation

/v1/{tenant}/punchline/executions

GET

Request
Parameters
string
Name Located in Required Description Schema
tenant path yes
Response
Status Code Reason Response Model
200 successful operation Array[Execution]

/v1/{tenant}/punchline/executions/{id}

GET

Request
Parameters
string string
Name Located in Required Description Schema
tenant path yes
id path yes
Response
Status Code Reason Response Model
200 successful operation Array[Execution]
404 Punchline not found -

/v1/{tenant}/punchline/save

POST

Request

Content-Type: multipart/mixed, multipart/form-data

Parameters
string file
Name Located in Required Description Schema
tenant path yes
file formData yes
Response
Status Code Reason Response Model
200 successful operation SavePunchlineResponse

/v1/{tenant}/punchline/scan

GET

Request
Parameters
string
Name Located in Required Description Schema
tenant path yes
Response

Content-Type: application/json

Status Code Reason Response Model
200 successful operation

/v1/{tenant}/punchline/scan/reset

DELETE

Request
Parameters
Response
Status Code Reason Response Model
default successful operation -

/v1/{tenant}/punchline/{id}

GET

Request
Parameters
string string
Name Located in Required Description Schema
tenant path yes
id path yes
Response
Status Code Reason Response Model
200 successful operation
404 Punchline not found -

POST

Request
Parameters
string string
Name Located in Required Description Schema
tenant path yes
id path yes
Response
Status Code Reason Response Model
200 successful operation
404 Punchline not found -

DELETE

Request
Parameters
string string
Name Located in Required Description Schema
tenant path yes
id path yes
Response
Status Code Reason Response Model
404 Punchline not found -

/v1/{tenant}/punchline/{punchlineId}/executions/{executionId}

GET

Request
Parameters
string string string
Name Located in Required Description Schema
tenant path yes
punchlineId path yes
executionId path yes
Response
Status Code Reason Response Model
200 successful operation IPunchResponse

/v1/{tenant}/registry

GET

Get a list of all resources.

Request
Parameters
string
Name Located in Required Description Schema
tenant path yes Tenant name
Response
Status Code Reason Response Model
200 Array[Metadata]
404 -

POST

Put a new resource

Request
Parameters
string file string
Name Located in Required Description Schema
tenant path yes Tenant name
file formData yes
path formData yes
Response
Status Code Reason Response Model
200 Resource create -
500 Resource not created -

/v1/{tenant}/registry/download/**

GET

Download a resource

Request
Parameters
string
Name Located in Required Description Schema
tenant path yes Tenant name
Response
Status Code Reason Response Model
200 Successful download -
404 Resource doesn't exist -

/v1/{tenant}/registry/metadata/**

GET

Get resource metadata.

Request
Parameters
string
Name Located in Required Description Schema
tenant path yes Tenant name
Response
Status Code Reason Response Model
200 Resource metadata MetadataDetails
404 -

Definitions

Execution

name type required description example
id string optional -
jobId string optional -
timestamp string optional -
duration integer (int64) optional -
tenant string optional -
event string optional -

ExtractionFields

name type required description example
name string optional -
type string optional -

ExtractionRequest

name type required description example
index string optional -
fields array[ExtractionFields] optional -
filters object optional -
description string optional -
format string optional -

IPunchResponse

name type required description example

InputStream

name type required description example

Metadata

name type required description example
name string optional -
location string optional -
updateTime string optional -
creationTime string optional -
version integer (int64) optional -

MetadataDetails

name type required description example
name string optional -
location string optional -
resource string optional -
timestamp string optional -
size integer (int64) optional -

PunchCtlChannelStatusResponse

name type required description example
status string optional -
jobs array[PunchCtlJobStatusResponse] optional -

PunchCtlJobStatusResponse

name type required description example
cluster string optional -
name string optional -
runtimeId string optional -
status string optional -
task string optional -

Resource

name type required description example
url string (url) optional -
file file optional -
open boolean optional -
filename string optional -
description string optional -
readable boolean optional -
uri string (uri) optional -
inputStream InputStream optional -

SavePunchlineResponse

name type required description example
index string optional -
id string optional -
tenant string optional -

TenantResponse

name type required description example
tenant string optional -