Skip to content

Latest commit

 

History

History
305 lines (162 loc) · 8.54 KB

EnclaveServiceApi.md

File metadata and controls

305 lines (162 loc) · 8.54 KB
Raw

\EnclaveServiceApi

All URIs are relative to http://api.madana.io/rest

Method HTTP request Description
add_history post /enclaves/{uuid}/history
approve_enclave post /enclaves/{uuid}/approval
assign_enclave_agent post /enclaves/{uuid}/assign
attestate_enclave post /enclaves/{uuid}/attestation
create_enclave_run_request post /enclaves
get_enclave get /enclaves/{uuid}
get_enclave_types get /enclaves/types
get_enclaves get /enclaves Returns UUIDs of existing analyses.
get_stats get /enclaves/stats
kill_enclave post /enclaves/{uuid}/kill

add_history

std::path::PathBuf add_history(uuid, body)

Parameters

Name Type Description Required Notes
uuid String [required]
body Option<JsonSignedData>

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

approve_enclave

std::path::PathBuf approve_enclave(uuid, body)

Parameters

Name Type Description Required Notes
uuid String [required]
body Option<JsonEnclaveRunningAttestationApproval>

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

assign_enclave_agent

std::path::PathBuf assign_enclave_agent(uuid, body)

Parameters

Name Type Description Required Notes
uuid String [required]
body Option<JsonNodeInfo>

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

attestate_enclave

std::path::PathBuf attestate_enclave(uuid, body)

Parameters

Name Type Description Required Notes
uuid String [required]
body Option<JsonEnclaveRunningAttestation>

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_enclave_run_request

std::path::PathBuf create_enclave_run_request(body)

Parameters

Name Type Description Required Notes
body Option<JsonEnclaveRunRequest>

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_enclave

std::path::PathBuf get_enclave(uuid)

Parameters

Name Type Description Required Notes
uuid String [required]

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_enclave_types

std::path::PathBuf get_enclave_types()

Parameters

This endpoint does not need any parameter.

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_enclaves

std::path::PathBuf get_enclaves(authorization, created, limit, offset, status) Returns UUIDs of existing analyses.

Returns UUIDs of existing analyses.

Parameters

Name Type Description Required Notes
authorization Option<String> Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
created Option<String> - if Queryparam "created=true" only the UUIDs of own Requests are shown [default to true]
limit Option<String> Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row [default to 30]
offset Option<String> Used for offset pagination. Limit/Offset Paging would look like GET /request?limit=20&offset=100. This query would return the 20 rows starting with the 100th row [default to 0]
status Option<String>

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_stats

std::path::PathBuf get_stats(dayssince)

Parameters

Name Type Description Required Notes
dayssince Option<String> [default to 30]

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

kill_enclave

std::path::PathBuf kill_enclave(uuid)

Parameters

Name Type Description Required Notes
uuid String [required]

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]