API request via cURL

Bretos · 2025-01-02T15:16:09.287Z

I feel like I'm an idiot, I'm trying to trigger library rescan via API ( https://immich.app/docs/api/scan-library ) To do that, I need to get library ID(s) - https://immich.app/docs/api/get-all-libraries/ Here's my command: ``` curl -X POST "https://immich.example.com/api/libraries?direction=getAllLibraries" \ -H "x-api-key: API_Key_created_in_user_settings_webui" \ -H "Content-Type: application/json" \ -d '{"ownerId": "id_of_my_user_with_ext_library"}' ``` the response I get: `{"id":"9adf1f07-5d22-49a0-a853-6c143b00cd4c","ownerId":"my_user_id","name":"New External Library","createdAt":"2025-01-02T15:11:08.046Z","updatedAt":"2025-01-02T15:11:08.046Z","refreshedAt":null,"assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]}` the effect I get: my user has just created a new external library. Currently existing are missing from the reponse. WTH am I doing wrong here??

I

Immich•1/2/25, 3:16 PM

:wave: Hey @Bretos,

Thanks for reaching out to us. Please carefully read this message and follow the recommended actions. This will help us be more effective in our support effort and leave more time for building Immich :immich:.

References

Container Logs:
```
docker compose logs
```
```
docker compose logs
```
docs
Container Status:
```
docker ps -a
```
```
docker ps -a
```
docs
Reverse Proxy: https://immich.app/docs/administration/reverse-proxy
Code Formatting https://support.discord.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline#h_01GY0DAKGXDEHE263BCAYEGFJA

I

Immich•1/2/25, 3:16 PM

Checklist

I have...

:ballot_box_with_check: verified I'm on the latest release(note that mobile app releases may take some time).
:ballot_box_with_check: read applicable release notes.
:ballot_box_with_check: reviewed the FAQs for known issues.
:ballot_box_with_check: reviewed Github for known issues.
:ballot_box_with_check: tried accessing Immich via local ip (without a custom reverse proxy).
:ballot_box_with_check: uploaded the relevant information (see below).
:ballot_box_with_check: tried an incognito window, disabled extensions, cleared mobile app cache, logged out and back in, different browsers, etc. as applicable

(an item can be marked as "complete" by reacting with the appropriate number)

Information

In order to be able to effectively help you, we need you to provide clear information to show what the problem is. The exact details needed vary per case, but here is a list of things to consider:

Your docker-compose.yml and .env files.
Logs from all the containers and their status (see above).
All the troubleshooting steps you've tried so far.
Any recent changes you've made to Immich or your system.
Details about your system (both software/OS and hardware).
Details about your storage (filesystems, type of disks, output of commands like
```
fdisk -l
```
```
fdisk -l
```
and
```
df -h
```
```
df -h
```
).
The version of the Immich server, mobile app, and other relevant pieces.
Any other information that you think might be relevant.

Please paste files and logs with proper code formatting, and especially avoid blurry screenshots.
Without the right information we can't work out what the problem is. Help us help you ;)

If this ticket can be closed you can use the

/close

/close

command, and re-open it later if needed.

IImmich ## Checklist I have... 1. :ballot_box_with_check: verified I'm on the latest rel...

I

ImmichAPP•1/2/25, 3:17 PM

Successfully submitted, a tag has been added to inform contributors. :white_check_mark:

D

Daniel•1/2/25, 3:23 PM

What is

?direction=getAllLibraries

?direction=getAllLibraries

?direction=getAllLibraries

?direction=getAllLibraries supposed to do?

D

Daniel•1/2/25, 3:23 PM

Also, only admin users can trigger a library scan

D

Daniel•1/2/25, 3:24 PM

Also, there's a cronjob you can customize that already re-scans the libraries every specified interval

B

BretosOP•1/2/25, 3:31 PM

OK, I think I've lost my head somewhere after last year and before current one. What's the correcth URL for

getAllLibraries

getAllLibraries

getAllLibraries

getAllLibraries then? does API require any additional arguments, like

direction

direction

direction

direction?

B

BretosOP•1/2/25, 3:33 PM

I want to trigger scan manually after a specific sync operation is completed, as inotify is funky over NFS

BBretos OK, I think I've lost my head somewhere after last year and before current one. ...

D

Daniel•1/2/25, 3:34 PM

/api/libraries

/api/libraries

/api/libraries

/api/libraries is correct, you need an admin api key though

D

Daniel•1/2/25, 3:35 PM

And no, it does not require any additional arguments, otherwise the docs would say so :)

B

BretosOP•1/2/25, 3:35 PM

admin api = api created via "setting" of an user that is an admin?

D

Daniel•1/2/25, 3:35 PM

Yep

B

BretosOP•1/2/25, 3:36 PM

curl -X POST "https://immich.example.com/api/libraries" \
-H "x-api-key: admin_api_key" \
-H "Content-Type: application/json" \
-H 'Accept: application/json' \
-d '{"ownerId": "5db5eb69-da0a-43f3-9715-1795923f0cc6"}'

{"id":"7656512b-98d2-4d94-a976-d26c2fb6e504","ownerId":"5db5eb69-da0a-43f3-9715-1795923f0cc6","name":"New External Library","createdAt":"2025-01-02T15:35:21.397Z","updatedAt":"2025-01-02T15:35:21.397Z","refreshedAt":null,"assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]}#

curl -X POST "https://immich.example.com/api/libraries" \
-H "x-api-key: admin_api_key" \
-H "Content-Type: application/json" \
-H 'Accept: application/json' \
-d '{"ownerId": "5db5eb69-da0a-43f3-9715-1795923f0cc6"}'

{"id":"7656512b-98d2-4d94-a976-d26c2fb6e504","ownerId":"5db5eb69-da0a-43f3-9715-1795923f0cc6","name":"New External Library","createdAt":"2025-01-02T15:35:21.397Z","updatedAt":"2025-01-02T15:35:21.397Z","refreshedAt":null,"assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]}#

curl -X POST "https://immich.example.com/api/libraries" \
-H "x-api-key: admin_api_key" \
-H "Content-Type: application/json" \
-H 'Accept: application/json' \
-d '{"ownerId": "5db5eb69-da0a-43f3-9715-1795923f0cc6"}'

{"id":"7656512b-98d2-4d94-a976-d26c2fb6e504","ownerId":"5db5eb69-da0a-43f3-9715-1795923f0cc6","name":"New External Library","createdAt":"2025-01-02T15:35:21.397Z","updatedAt":"2025-01-02T15:35:21.397Z","refreshedAt":null,"assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]}#

curl -X POST "https://immich.example.com/api/libraries" \
-H "x-api-key: admin_api_key" \
-H "Content-Type: application/json" \
-H 'Accept: application/json' \
-d '{"ownerId": "5db5eb69-da0a-43f3-9715-1795923f0cc6"}'

{"id":"7656512b-98d2-4d94-a976-d26c2fb6e504","ownerId":"5db5eb69-da0a-43f3-9715-1795923f0cc6","name":"New External Library","createdAt":"2025-01-02T15:35:21.397Z","updatedAt":"2025-01-02T15:35:21.397Z","refreshedAt":null,"assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]}#

still the same issue, creates new library and doesn't list the existing one.

B

BretosOP•1/2/25, 3:37 PM

when I POST at

curl -X POST "https://immich.example.com/api/libraries/getAllLibraries" \

curl -X POST "https://immich.example.com/api/libraries/getAllLibraries" \

curl -X POST "https://immich.example.com/api/libraries/getAllLibraries" \

curl -X POST "https://immich.example.com/api/libraries/getAllLibraries" \

I get the response:

{"message":"Cannot POST /api/libraries/getAllLibraries","error":"Not Found","statusCode":404,"correlationId":"0c92j5ys"}#

{"message":"Cannot POST /api/libraries/getAllLibraries","error":"Not Found","statusCode":404,"correlationId":"0c92j5ys"}#

{"message":"Cannot POST /api/libraries/getAllLibraries","error":"Not Found","statusCode":404,"correlationId":"0c92j5ys"}#

{"message":"Cannot POST /api/libraries/getAllLibraries","error":"Not Found","statusCode":404,"correlationId":"0c92j5ys"}#

BBretos when I POST at `curl -X POST "https://immich.example.com/api/libraries/getAllLib...

D

Daniel•1/2/25, 3:37 PM

Yes, this endpoint does not exist

BBretos ```curl -X POST "https://immich.example.com/api/libraries" \ -H "x-api-key: admi...

D

Daniel•1/2/25, 3:37 PM

Why are you sending

{ownerId: }

{ownerId: }

{ownerId: }

{ownerId: }?

B

BretosOP•1/2/25, 3:38 PM

because otherwise

{"message":["ownerId must be a UUID","ownerId should not be empty","ownerId must be a string"],"error":"Bad Request","statusCode":400,"correlationId":"al7r8dpl"}#

{"message":["ownerId must be a UUID","ownerId should not be empty","ownerId must be a string"],"error":"Bad Request","statusCode":400,"correlationId":"al7r8dpl"}#

{"message":["ownerId must be a UUID","ownerId should not be empty","ownerId must be a string"],"error":"Bad Request","statusCode":400,"correlationId":"al7r8dpl"}#

{"message":["ownerId must be a UUID","ownerId should not be empty","ownerId must be a string"],"error":"Bad Request","statusCode":400,"correlationId":"al7r8dpl"}#

DDaniel Yes, this endpoint does not exist

B

BretosOP•1/2/25, 3:40 PM

so how do I call directly to

getAllLibraries

getAllLibraries

getAllLibraries

getAllLibraries?

BBretos so how do I call directly to `getAllLibraries`?

D

Daniel•1/2/25, 3:45 PM

You don't call

getAllLibraries

getAllLibraries

getAllLibraries

getAllLibraries

D

Daniel•1/2/25, 3:45 PM

The endpoint is called

libraries

libraries

libraries

libraries

D

Daniel•1/2/25, 3:45 PM

Are you using AI for this?

BBretos because otherwise `{"message":["ownerId must be a UUID","ownerId should not be e...

D

Daniel•1/2/25, 3:45 PM

This is odd and should not happen

D

Daniel•1/2/25, 3:45 PM

Which version is your Immich server on?

B

BretosOP•1/2/25, 3:45 PM

Lol, we're doomed if I am

B

BretosOP•1/2/25, 3:46 PM

1.123.0

BBretos Lol, we're doomed if I am

D

Daniel•1/2/25, 3:46 PM

Yeah, I am just confused where you get all this stuff from, e.g. the

?direction=

?direction=

?direction=

?direction= param

B

BretosOP•1/2/25, 3:46 PM

I tried some random stuff after it didn't work like I expected, mainly from https://github.com/immich-app/immich/discussions/13081

D

Daniel•1/2/25, 3:47 PM

Can you try it against the demo instance?

D

Daniel•1/2/25, 3:47 PM

As that works for me

B

BretosOP•1/2/25, 3:49 PM

# curl -X POST "https://demo.immich.app/api/libraries/" \
-H "x-api-key: pTpFSM4gaVlFSZ2IVOTUDU6KgewmVEhR8tyI4wUjJs" \
-H 'Accept: application/json'
{"message":["ownerId must be a UUID","ownerId should not be empty","ownerId must be a string"],"error":"Bad Request","statusCode":400,"correlationId":"x7bxmiwa"}

# curl -X POST "https://demo.immich.app/api/libraries/" \
-H "x-api-key: pTpFSM4gaVlFSZ2IVOTUDU6KgewmVEhR8tyI4wUjJs" \
-H 'Accept: application/json'
{"message":["ownerId must be a UUID","ownerId should not be empty","ownerId must be a string"],"error":"Bad Request","statusCode":400,"correlationId":"x7bxmiwa"}

# curl -X POST "https://demo.immich.app/api/libraries/" \
-H "x-api-key: pTpFSM4gaVlFSZ2IVOTUDU6KgewmVEhR8tyI4wUjJs" \
-H 'Accept: application/json'
{"message":["ownerId must be a UUID","ownerId should not be empty","ownerId must be a string"],"error":"Bad Request","statusCode":400,"correlationId":"x7bxmiwa"}

# curl -X POST "https://demo.immich.app/api/libraries/" \
-H "x-api-key: pTpFSM4gaVlFSZ2IVOTUDU6KgewmVEhR8tyI4wUjJs" \
-H 'Accept: application/json'
{"message":["ownerId must be a UUID","ownerId should not be empty","ownerId must be a string"],"error":"Bad Request","statusCode":400,"correlationId":"x7bxmiwa"}

D

Daniel•1/2/25, 3:50 PM

Oh wait I see your issue

D

Daniel•1/2/25, 3:50 PM

B

BretosOP•1/2/25, 3:50 PM

but then...

 curl -L "https://demo.immich.app/api/libraries/" \
-H 'Accept: application/json' \
-H "x-api-key: pTpFSM4gaVlFSZ2IVOTUDU6KgewmVEhR8tyI4wUjJs"
[{"id":"d7648f56-f5a3-4d41-a5f1-2b13e6c88ba9","ownerId":"aff6f1bc-c40e-40d4-a7f1-832762b8e407","name":"New External Library","createdAt":"2025-01-02T12:43:36.176Z","updatedAt":"2025-01-02T14:27:26.760Z","refreshedAt":"2025-01-02T14:27:26.755Z","assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]},{"id":"9d02aa99-7175-4d25-b58f-2b28b3faa538","ownerId":"0c389df9-5476-4c01-acf9-1ccefb0448f7","name":"New External Library","createdAt":"2025-01-02T13:12:04.835Z","updatedAt":"2025-01-02T14:27:26.755Z","refreshedAt":"2025-01-02T14:27:26.752Z","assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]}]

 curl -L "https://demo.immich.app/api/libraries/" \
-H 'Accept: application/json' \
-H "x-api-key: pTpFSM4gaVlFSZ2IVOTUDU6KgewmVEhR8tyI4wUjJs"
[{"id":"d7648f56-f5a3-4d41-a5f1-2b13e6c88ba9","ownerId":"aff6f1bc-c40e-40d4-a7f1-832762b8e407","name":"New External Library","createdAt":"2025-01-02T12:43:36.176Z","updatedAt":"2025-01-02T14:27:26.760Z","refreshedAt":"2025-01-02T14:27:26.755Z","assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]},{"id":"9d02aa99-7175-4d25-b58f-2b28b3faa538","ownerId":"0c389df9-5476-4c01-acf9-1ccefb0448f7","name":"New External Library","createdAt":"2025-01-02T13:12:04.835Z","updatedAt":"2025-01-02T14:27:26.755Z","refreshedAt":"2025-01-02T14:27:26.752Z","assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]}]

 curl -L "https://demo.immich.app/api/libraries/" \
-H 'Accept: application/json' \
-H "x-api-key: pTpFSM4gaVlFSZ2IVOTUDU6KgewmVEhR8tyI4wUjJs"
[{"id":"d7648f56-f5a3-4d41-a5f1-2b13e6c88ba9","ownerId":"aff6f1bc-c40e-40d4-a7f1-832762b8e407","name":"New External Library","createdAt":"2025-01-02T12:43:36.176Z","updatedAt":"2025-01-02T14:27:26.760Z","refreshedAt":"2025-01-02T14:27:26.755Z","assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]},{"id":"9d02aa99-7175-4d25-b58f-2b28b3faa538","ownerId":"0c389df9-5476-4c01-acf9-1ccefb0448f7","name":"New External Library","createdAt":"2025-01-02T13:12:04.835Z","updatedAt":"2025-01-02T14:27:26.755Z","refreshedAt":"2025-01-02T14:27:26.752Z","assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]}]

 curl -L "https://demo.immich.app/api/libraries/" \
-H 'Accept: application/json' \
-H "x-api-key: pTpFSM4gaVlFSZ2IVOTUDU6KgewmVEhR8tyI4wUjJs"
[{"id":"d7648f56-f5a3-4d41-a5f1-2b13e6c88ba9","ownerId":"aff6f1bc-c40e-40d4-a7f1-832762b8e407","name":"New External Library","createdAt":"2025-01-02T12:43:36.176Z","updatedAt":"2025-01-02T14:27:26.760Z","refreshedAt":"2025-01-02T14:27:26.755Z","assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]},{"id":"9d02aa99-7175-4d25-b58f-2b28b3faa538","ownerId":"0c389df9-5476-4c01-acf9-1ccefb0448f7","name":"New External Library","createdAt":"2025-01-02T13:12:04.835Z","updatedAt":"2025-01-02T14:27:26.755Z","refreshedAt":"2025-01-02T14:27:26.752Z","assetCount":0,"importPaths":[],"exclusionPatterns":["**/@eaDir/**","**/._*"]}]

D

Daniel•1/2/25, 3:51 PM

Exactly

D

Daniel•1/2/25, 3:51 PM

You were POSTing

D

Daniel•1/2/25, 3:51 PM

But this is a GET endpoint

B

BretosOP•1/2/25, 3:51 PM

lol

D

Daniel•1/2/25, 3:52 PM

It returns all external libraries, which is to be expected no?

B

BretosOP•1/2/25, 3:52 PM

let me try that on my instance

DDaniel It returns all external libraries, which is to be expected no?

B

BretosOP•1/2/25, 3:52 PM

yeah I just assumed they have different names without checking that first, that's why I deleted my message after checking it

D

Daniel•1/2/25, 3:52 PM

Ah lol

D

Daniel•1/2/25, 3:53 PM

I am surprised the POST gave you anything tbh

B

BretosOP•1/2/25, 3:53 PM

OMG one would think that after enough years one can write a simple api request on one's own

D

Daniel•1/2/25, 3:53 PM

D

Daniel•1/2/25, 3:53 PM

Happens to the best

B

BretosOP•1/2/25, 3:53 PM

and then we get here anyway

B

BretosOP•1/2/25, 3:53 PM

it works, thank you @Daniel !

D

Daniel•1/2/25, 3:53 PM

And I didn't spot it immediately either :D

B

BretosOP•1/2/25, 3:54 PM

yeah post created new ext library

D

Daniel•1/2/25, 3:57 PM

Ooooohh

API request via cURL

References

Checklist

Information

Similar Threads

Similar Threads

Similar Threads

References

Checklist

Information