% OCI-API(1) Version 3.2.0 | Scripts Documentation
% Georg Voell - georg.voell@standby.cloud
% (c)2024 Standby.cloud

NAME
====

**oci-api** - (BASH Script) This script is a wrapper for the OCI REST API.

SYNOPSIS
========

| **oci-api** \[_options_] _endpoint_ _method_ \[_filename_] _request_ 

DESCRIPTION
===========

This script is a wrapper for the OCI REST API.

Options
-------

-h, \--help           

:  Displays helptext.

-v, \--version        

:  Displays the version of the script.

Endpoint
-------

 REST endpoint e.g. "iaas.eu-frankfurt-1.oraclecloud.com".

Method  
-------

 get | head | post | put | delete.

Filename
-------

 Optional filename needed together with post or put

Request 
-------

 Request that is appended to endpoint e.g. "/20160918/volumeAttachments?compartmentId=$cid"


EXAMPLES
========

List compartments:

: oci-api identity.eu-frankfurt-1.oraclecloud.com get /20160918/compartments/?compartmentId=ocid1.tenancy.oc1..amgxr35ltsgdy63lzts6jm2qtil7ug2wpm6uc2kweau6det


EXIT CODES
==========

001: Unknown or wrong parameter.

002: Exit code from curl (2 - 98)

099: User interrupt.

100: No 'jq' in PATH

101: External variables not set (e.g. TENANCY_ID, API_USER_ID, KEY_FINGERPRINT, PRIVATE_KEY_PATH)

102: Head returned other code then 200 (ok)

103: No variable "code" in JSON

104: Empty body file

105: S3 not yet implemented