Primeur

Primeur API

Primeur API as documented publicly: 17 operations. Contract generated from the documentation by API Evangelist (2026-10-21); not the provider's own document.

GitHub OpenAPI

Operations 17

GET /2.0/countelements/httpapi GET /2.0/countelements/httpapi #
GET /2.0/directories/httpapi GET /2.0/directories/httpapi #
GET /2.0/files/http_api/HttpUploadV2.txt Downloads the file `` located in ``. #
PUT /2.0/files/http_api/HttpUploadV2.txt PUT /2.0/files/http_api/HttpUploadV2.txt #
DELETE /2.0/files/http_api/HttpUploadV2Cookies_3.txt DELETE /2.0/files/http_api/HttpUploadV2Cookies_3.txt #
GET /2.0/files/http_api/HttpUploadV2Cookies_3.txt GET /2.0/files/http_api/HttpUploadV2Cookies_3.txt #
POST /2.0/files/httpapi POST /2.0/files/httpapi #
GET /2.0/login/basic GET /2.0/login/basic #
GET /2.0/metadata/http_api/HttpUploadV2Cookies_3.txt GET /2.0/metadata/http_api/HttpUploadV2Cookies_3.txt #
GET /2.0/metadata/httpapi/HttpUploadV2Cookies_3.txt Retrieves the list of metadata associated with the file `` located in ``. #
POST /2.0/metadata/httpapi/HttpUploadV2Cookies_3.txt POST /2.0/metadata/httpapi/HttpUploadV2Cookies_3.txt #
DELETE /data-one-application/api/v1/infrastructure/clusters/server-sessions DELETE /data-one-application/api/v1/infrastructure/clusters/server-sessions #
POST /data-one-application/api/v1/infrastructure/clusters/server-sessions/query POST /data-one-application/api/v1/infrastructure/clusters/server-sessions/query #
GET /ghibli-rest/v3/clusters To find it, call GET /ghibli-rest/v3/clusters #
GET /job-manager/jobs This API retrieves job details in Data Mover. The search is executed with an exact matching for all fields. #
POST /job-manager/jobs This API submits a new job to Data Mover #
POST /login/basic Authenticates a user and starts a new session on the configured HTTP / HTTPS server. #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/primeur/openapi/_ae-authored/primeur-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/primeur/json-schema/primeur-get20-metadata-http-api-httpuploadv2-cookies3-txt-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/primeur/json-schema/primeur-post-job-manager-jobs-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/primeur/json-schema/primeur-post-job-manager-jobs-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/primeur/json-schema/primeur-delete-data-one-application-api-v1-infrastructure-clusters-server-ses2-schema.json
📊
JSONSchema
https://artifacts.apis.io/primeur/json-schema/primeur-post-data-one-application-api-v1-infrastructure-clusters-server-sessi-schema.json
📊
JSONSchema
https://artifacts.apis.io/primeur/json-schema/primeur-delete-data-one-application-api-v1-infrastructure-clusters-server-ses-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/primeur/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/primeur:primeur-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

primeur-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Primeur API
  version: '2026-10-21'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-21: 17 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Primeur has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 11
    documentation: 6
    pages-with-code: 2
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-21'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.primeur.com/data-mover-1.20/api/job-manager-apis.md
  - https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
  - https://docs.primeur.com/data-mover-1.20/api/sftp-server-sessions-apis.md
  - https://docs.primeur.com/data-mover-1.20/transfer-protocols-and-connectors/configure-hsm-for-pr4s-client-and-server-connections.md
paths:
  /2.0/countelements/httpapi:
    get:
      operationId: get_2_0_countelements_httpapi
      tags:
      - '2'
      summary: GET /2.0/countelements/httpapi
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      parameters:
      - name: type
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl\ncurl -i -u part1:partner1 -X GET -v \"https://myHostName:21080/2.0/countelements/httpapi?type=all\" \n   -b cookies.txt\n\
          ```"
  /2.0/directories/httpapi:
    get:
      operationId: get_2_0_directories_httpapi
      tags:
      - '2'
      summary: GET /2.0/directories/httpapi
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      parameters:
      - name: direction
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: string
      - name: sort
        in: query
        required: false
        schema:
          type: string
      - name: start
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl\ncurl -i  -X GET -v \"https://myHostName:21080/2.0/directories/httpapi?sort=size&direction=DESC&start=0&limit=25\" \n \
          \  -o cookies.txt\n```\n"
  /2.0/files/http_api/HttpUploadV2.txt:
    get:
      operationId: get_2_0_files_http_api_HttpUploadV2_txt
      tags:
      - '2'
      summary: Downloads the file `<file>` located in `<path>`.
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_2_0_files_http_api_HttpUploadV2_txt
      tags:
      - '2'
      summary: PUT /2.0/files/http_api/HttpUploadV2.txt
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl\ncurl -i -X PUT -v \"http://myHostName:21080/2.0/files/http_api/HttpUploadV2.txt\" \n-H \"Content-Type: multipart/form-data\"\
          \  \n-F \"file=@test.sh;type=application/octet-stream\"  \n-b cookies.txt\n```"
  /2.0/files/http_api/HttpUploadV2Cookies_3.txt:
    delete:
      operationId: delete_2_0_files_http_api_HttpUploadV2Cookies_3_txt
      tags:
      - '2'
      summary: DELETE /2.0/files/http_api/HttpUploadV2Cookies_3.txt
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl\ncurl -i -X DELETE https://myHostName:21080/2.0/files/http_api/HttpUploadV2Cookies_3.txt \n   -b cookies.txt\n```"
    get:
      operationId: get_2_0_files_http_api_HttpUploadV2Cookies_3_txt
      tags:
      - '2'
      summary: GET /2.0/files/http_api/HttpUploadV2Cookies_3.txt
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl\ncurl -X GET https://myHostName:21080/2.0/files/http_api/HttpUploadV2Cookies_3.txt  \n   -o download_file.txt \n   -b cookies.txt\n\
          ```"
  /2.0/files/httpapi:
    post:
      operationId: post_2_0_files_httpapi
      tags:
      - '2'
      summary: POST /2.0/files/httpapi
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl\ncurl -i -X POST -v \"https://myHostName:21080/2.0/files/httpapi\" \n -H \"Content-Type: multipart/form-data\"\n -F \"\
          file=@test.txt;type=application/octet-stream\"  \n -F 'metadata={\"SPFB_SP2_FILE_SYS_MD.QUEUE_NAME\":\"QUEUE1\", \"SPFB_SP2_FILE_SYS_MD.CORRELATION_ID\"\
          :\"invoices.xslx\"}' \n -b cookies.txt\n```"
  /2.0/login/basic:
    get:
      operationId: get_2_0_login_basic
      tags:
      - '2'
      summary: GET /2.0/login/basic
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl\ncurl -v \"https://myHostName:21080/2.0/login/basic\" \n-H 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8'\
          \  \n-d 'username=jdoe&password=secret'\n-c cookies.txt\n```"
  /2.0/metadata/http_api/HttpUploadV2Cookies_3.txt:
    get:
      operationId: get_2_0_metadata_http_api_HttpUploadV2Cookies_3_txt
      tags:
      - '2'
      summary: GET /2.0/metadata/http_api/HttpUploadV2Cookies_3.txt
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Get20MetadataHttpApiHttpuploadv2Cookies3TxtResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl\ncurl -i-X GET -v \"http://myHostName:21080/2.0/metadata/http_api/HttpUploadV2Cookies_3.txt \n    -H \"Accept: application/json\"\
          \ \n    -b cookies.txt\n```"
  /2.0/metadata/httpapi/HttpUploadV2Cookies_3.txt:
    get:
      operationId: get_2_0_metadata_httpapi_HttpUploadV2Cookies_3_txt
      tags:
      - '2'
      summary: Retrieves the list of metadata associated with the file `<file>` located in `<path>`.
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_2_0_metadata_httpapi_HttpUploadV2Cookies_3_txt
      tags:
      - '2'
      summary: POST /2.0/metadata/httpapi/HttpUploadV2Cookies_3.txt
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Post20MetadataHttpapiHttpuploadv2Cookies3TxtRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl\ncurl -i -X POST -v \"https://myHostName:21080/2.0/metadata/httpapi/HttpUploadV2Cookies_3.txt\" \n   -H \"Content-Type:\
          \ application/json\" \n   -d '{\"OFFICE\":\"Accounting\", \"CITY\":\"London\"}' \n   -b cookies.txt\n```"
  /data-one-application/api/v1/infrastructure/clusters/server-sessions:
    delete:
      operationId: delete_data_one_application_api_v1_infrastructure_clusters_server_sessions
      tags:
      - Data One Application
      summary: DELETE /data-one-application/api/v1/infrastructure/clusters/server-sessions
      x-source: https://docs.primeur.com/data-mover-1.20/api/sftp-server-sessions-apis.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDataOneApplicationApiV1InfrastructureClustersServerSes'
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDataOneApplicationApiV1InfrastructureClustersServerSes2'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl

          curl -X ''DELETE'' \ ''https://localhost:9443/data-one-application/api/v1/infrastructure/clusters/server-sessions''  -H ''accept: */*''  -H
          ''Authorization: Bearer {authorization token here}''  -H ''Content-Type: application/json''  -d ''{  "clusterName": "cluster1",  "peerName":
          "peer1",  "protocol": "sftp",  "serverName": "sftp-server",  "sessionId": "17B63E2D99659D7B806BC47B866EBDC0F16FDAFE21AF072563'
  /data-one-application/api/v1/infrastructure/clusters/server-sessions/query:
    post:
      operationId: post_data_one_application_api_v1_infrastructure_clusters_server_sessions_query
      tags:
      - Data One Application
      summary: POST /data-one-application/api/v1/infrastructure/clusters/server-sessions/query
      x-source: https://docs.primeur.com/data-mover-1.20/api/sftp-server-sessions-apis.md
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostDataOneApplicationApiV1InfrastructureClustersServerSessi'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X 'POST'  'https://localhost:9443/data-one-application/api/v1/infrastructure/clusters/server-sessions/query'  -H 'accept:\
          \ application/json'  -H 'Authorization: Bearer {authorization token here}'  -H 'Content-Type: application/json'  -d '\n{   \"clusterName\"\
          : \"cluster1\",   \"peerName\": \"peer1\",   \"protocol\": \"SFTP\",   \"serverName\": \"sftp-server\",   \"maxItem\": 100,   \"sort\"\
          : \"asc\" }' \n```"
  /ghibli-rest/v3/clusters:
    get:
      operationId: get_ghibli_rest_v3_clusters
      tags:
      - Ghibli Rest
      summary: To find it, call GET /ghibli-rest/v3/clusters
      x-source: https://docs.primeur.com/data-mover-1.20/transfer-protocols-and-connectors/configure-hsm-for-pr4s-client-and-server-connections.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /job-manager/jobs:
    get:
      operationId: get_job_manager_jobs
      tags:
      - Job Manager
      summary: This API retrieves job details in Data Mover. The search is executed with an exact matching for all fields.
      description: The response is a list of JSON objects, each representing a job in the system.
      x-source: https://docs.primeur.com/data-mover-1.20/api/job-manager-apis.md
      parameters:
      - name: maxItems
        in: query
        required: false
        schema:
          type: integer
        description: Maximum number of values that the server should return (must be less than or equal to 1000)
      - name: sort
        in: query
        required: false
        schema:
          type: string
        description: Sort field (+ = ASC, - = DESC, e.g. '+id', '+status', '-contract', '+createdAt')
      - name: id
        in: query
        required: false
        schema:
          type: string
        description: Job id
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: 'The job status: SUBMITTED, SUSPENDED, RUNNING, ERROR, ABORTED, COMPLETED'
      - name: queue
        in: query
        required: false
        schema:
          type: string
        description: Job queue
      - name: contract
        in: query
        required: false
        schema:
          type: string
        description: Contract name
      - name: workflowTemplateId
        in: query
        required: false
        schema:
          type: string
        description: Id of the workflow template
      - name: workflowTemplateName
        in: query
        required: false
        schema:
          type: string
        description: Name of the workflow template
      - name: workflowTemplateRevision
        in: query
        required: false
        schema:
          type: string
        description: Revision number of the workflow template
      - name: createdAtFrom
        in: query
        required: false
        schema:
          type: string
        description: Creation time lower-bound in ISO8601 format
      - name: createdAtTo
        in: query
        required: false
        schema:
          type: string
        description: Creation time upper-bound in ISO8601 format
      - name: updatedAtFrom
        in: query
        required: false
        schema:
          type: string
        description: Update time lower-bound in ISO8601 format
      - name: updatedAtTo
        in: query
        required: false
        schema:
          type: string
        description: Update time upper-bound in ISO8601 format
      - name: extIPID
        in: query
        required: false
        schema:
          type: string
        description: External idempotency identifier
      - name: submittedBy
        in: query
        required: false
        schema:
          type: string
        description: Job submitter
      - name: dfiid
        in: query
        required: false
        schema:
          type: string
        description: Dataflow instance Id
      - name: lcid
        in: query
        required: false
        schema:
          type: string
        description: Log Correlation Id
      - name: actor
        in: query
        required: false
        schema:
          type: string
        description: Actor
      - name: contractAction
        in: query
        required: false
        schema:
          type: string
        description: Action defined in the contract
      - name: contractType
        in: query
        required: false
        schema:
          type: string
        description: Type of contract
      - name: contractActionTrigger
        in: query
        required: false
        schema:
          type: string
        description: Trigger defined in the contract
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobManagerJobsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_job_manager_jobs
      tags:
      - Job Manager
      summary: This API submits a new job to Data Mover
      description: The API will return the newly submitted job (response code 201), or the existing one if collision is detected (response code
        409).
      x-source: https://docs.primeur.com/data-mover-1.20/api/job-manager-apis.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostJobManagerJobsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostJobManagerJobsResponse'
      x-evidence:
        kind: documentation
  /login/basic:
    post:
      operationId: post_login_basic
      tags:
      - Login
      summary: Authenticates a user and starts a new session on the configured HTTP / HTTPS server.
      x-source: https://docs.primeur.com/data-mover-1.20/api/http-mft-rest-apis.md
      parameters:
      - name: username
        in: query
        required: true
        schema:
          type: string
        description: Username
      - name: password
        in: query
        required: true
        schema:
          type: string
        description: The user password
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    Get20MetadataHttpApiHttpuploadv2Cookies3TxtResponse:
      type: object
      properties:
        id:
          type: string
        filename:
          type: string
        fileset:
          type: integer
        owner:
          type: string
        directory:
          type: boolean
        attributes:
          type: object
          properties:
            firstReadDate:
              type: string
            lastModifiedTime:
              type: string
              format: date-time
            size:
              type: string
            creationTime:
              type: string
              format: date-time
            datatype:
              type: string
            description:
              type: string
            correlationId:
              type: string
            putDate:
              type: string
              format: date-time
    Post20MetadataHttpapiHttpuploadv2Cookies3TxtRequest:
      type: object
      properties:
        OFFICE:
          type: string
        CITY:
          type: string
    DeleteDataOneApplicationApiV1InfrastructureClustersServerSes:
      type: object
      properties:
        clusterName:
          type: string
        peerName:
          type: string
        protocol:
          type: string
        serverName:
          type: string
        sessionId:
          type: string
    DeleteDataOneApplicationApiV1InfrastructureClustersServerSes2:
      type: object
      properties:
        sessionId:
          type: string
        userName:
          type: string
        clientIp:
          type: string
        clientPort:
          type: string
        clientVersion:
          type: string
    PostDataOneApplicationApiV1InfrastructureClustersServerSessi:
      type: object
      properties:
        sessionId:
          type: string
        userName:
          type: string
        clientIp:
          type: string
        clientPort:
          type: string
        clientVersion:
          type: string
    GetJobManagerJobsResponse:
      type: object
      properties:
        jobs:
          type: array
          description: List of job objects
        next:
          type: string
          description: Link to the next page if available
    PostJobManagerJobsRequest:
      type: object
      properties:
        contractName:
          type: string
        actionName:
          type: string
        actionVariables:
          type: object
        extIPID:
          type: string
      required:
      - contractName
      - actionName
      - actionVariables
      - extIPID
    PostJobManagerJobsResponse:
      type: object
      properties:
        id:
          type: integer
        status:
          type: string
        statusMessage:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
        submittedBy:
          type: string
        queue:
          type: string
        actor:
          type: string
        contract:
          type: string
        contractType:
          type: string
        contractAction:
          type: string
        contractActionTrigger:
          type: string
        contractActionWorkflowInstance:
          type: object
        dfic:
          type: object
        extIPID:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: '2'
- name: Data One Application
- name: Ghibli Rest
- name: Job Manager
- name: Login