User Configs endpoints
This document contains the endpoints for the User Configs category.
/api/v1/user/configs
Authorized
This endpoint returns all configuration entries for the authenticated user
Request examples
/v1/user/configs
Authorized
curl --location 'http://localhost/api/v1/user/configs'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/user/configs" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/user/configs"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/user/configs/{id}
Authorized
This endpoint returns a single configuration entry for the authenticated user
Parameters
Name
Type
In
Required
Description
idstringpath
required
Config ID or Slug
Request examples
/v1/user/configs/{id}
Authorized
curl --location 'http://localhost/api/v1/user/configs/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/user/configs/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/user/configs/{id}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/user/configs
Authorized
This endpoint creates a configuration entry for the authenticated user
Parameters
Name
Type
In
Required
Description
userConfigobjectbody
optional
Body
Request examples
/v1/user/configs
Authorized
curl --location 'http://localhost/api/v1/user/configs'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/user/configs" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/user/configs"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/user/configs/{id}
Authorized
This endpoint updates a configuration entry for the authenticated user
Parameters
Name
Type
In
Required
Description
idstringpath
required
Config ID or Slug
userConfigobjectbody
optional
Body
Request examples
/v1/user/configs/{id}
Authorized
curl --location 'http://localhost/api/v1/user/configs/{id}'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/user/configs/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/user/configs/{id}"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/user/configs/{id}
Authorized
This endpoint deletes a configuration entry for the authenticated user
Parameters
Name
Type
In
Required
Description
idstringpath
required
Config ID or Slug
Request examples
/v1/user/configs/{id}
Authorized
curl --location 'http://localhost/api/v1/user/configs/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/user/configs/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/user/configs/{id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
