Head object

Receives information about the properties of the object in the baquette

Parameters

Function HeadObject(Val Name, Val Bucket, Val BasicData, Val Version = Undefined, Val Headers = Undefined, Val Directory = False) Export

Parameter	CLI option	Type	Required	Description
Name	--name	String	✔	Name of the object in the bucket
Bucket	--bucket	String	✔	Name of the bucket in which the object is stored
BasicData	--basic	Structure Of KeyAndValue	✔	Basic request data. See GetBasicDataStructure
Version	--ver	String	✖	Token for receiving a specific version of an object
Headers	--headers	Map Of KeyAndValue	✖	Additional request headers, if necessary
Directory	--dir	Boolean	✖	True > Path style URL, False > Virtual hosted style URL

Returns

Structure Of KeyAndValue - serialized JSON response from storage

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Object metadata is contained in the headers

Method at AWS documentation: GetObjectAttributes

1C:Enterprise/OneScript code example

    URL       = "s3.openintegrations.dev";
    AccessKey = "bayselo...";
    SecretKey = "12we34...";
    Region    = "BTC";

    BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);

    Name = "picture.jpg";

    Directory = True; // Formation URL in path-style
    Bucket = "w567hjy1";
    Result = OPI_S3.HeadObject(Name, Bucket, BasicData, , , Directory);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint s3 HeadObject \
      --name "pictureU.jpg" \
      --bucket "newbucket2" \
      --basic "{'URL':'s3.openintegrations.dev','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint s3 HeadObject ^
      --name "pictureU.jpg" ^
      --bucket "newbucket2" ^
      --basic "{'URL':'s3.openintegrations.dev','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"

Result

{
 "status": 200,
 "response": {},
 "headers": {
  "Accept-Ranges": "bytes",
  "ETag": "\"9e0176f87f6565a22f78e0f9b39a4d78\"",
  "Vary": "Accept-Encoding",
  "Server": "Microsoft-IIS/10.0",
  "Strict-Transport-Security": "max-age=31536000; includeSubDomains",
  "X-Amz-Id-2": "dd9025bab4ad464b049177c95eb6ebf374d3b3fd1af9251148b658df7ac2e3e8",
  "X-Amz-Request-Id": "18B323C9EE030BE7",
  "X-Content-Type-Options": "nosniff",
  "X-Ratelimit-Limit": "6518",
  "X-Ratelimit-Remaining": "6518",
  "X-XSS-Protection": "1; mode=block",
  "X-Powered-By": "ARR/3.0",
  "Date": "Tue, 26 May 2026 14:27:07 GMT",
  "Content-Length": "2114023",
  "Content-Type": "application/octet-stream",
  "Last-Modified": "Tue, 26 May 2026 14:26:43 GMT"
 }
}